Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: summarize g2p errors in assemble and on the CLI #263

Merged
merged 1 commit into from
Feb 28, 2025

Conversation

joanise
Copy link
Member

@joanise joanise commented Feb 25, 2025

PR Goal?

In assemble, just list the words that could not be g2p'd, so the error message shown to the user in Studio-Web is legible.

In the CLI, add a summary list of the words that could not be g2p's in the error message.

Fixes?

Unreadably verbose errors shown to users in Studio-Web when some tokens cannot be g2p'd.

Feedback sought?

sanity checking

Priority?

before ICLDC ideally

Tests added?

yes

How to test?

In Studio:

./run_web_api.sh

In Studio-Web:

npx nx build web-component
npx nx serve studio-web

Navigate to http://localhost:4200/ and put non-g2p-able text like 54:23 1223:563 54:23 and see the nice and sweet error message like this when you click on next step:
{59EF933A-DF50-439C-95EE-BD8861BA66EA}

Confidence?

high

Version change?

Before ICLDC, I might choose to bump Studio's version to 1.2.2 with the several little patches we've done recently.

In assemble, just list the words that could not be g2p'd, so the error
message shown to the user in Studio-Web is legible.

In the CLI, add a summary list of the words that could not be g2p's in
the error message.
Copy link

semanticdiff-com bot commented Feb 25, 2025

Review changes with  SemanticDiff

Changed Files
File Status
  readalongs/text/make_package.py  81% smaller
  readalongs/align_utils.py  73% smaller
  readalongs/cli.py  68% smaller
  test/test_web_api.py  14% smaller
  readalongs/text/convert_xml.py  1% smaller
  readalongs/web_api.py  0% smaller
  test/test_g2p_cli.py  0% smaller

@joanise joanise requested a review from roedoejet February 25, 2025 19:48
Copy link

codecov bot commented Feb 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.44%. Comparing base (34c76da) to head (89aa16c).

Additional details and impacted files
@@                      Coverage Diff                      @@
##           dev.ej/timelimit-assemble     #263      +/-   ##
=============================================================
+ Coverage                      88.41%   88.44%   +0.03%     
=============================================================
  Files                             22       22              
  Lines                           1864     1869       +5     
  Branches                         338      339       +1     
=============================================================
+ Hits                            1648     1653       +5     
  Misses                           179      179              
  Partials                          37       37              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@joanise joanise requested a review from deltork February 25, 2025 22:42
Base automatically changed from dev.ej/timelimit-assemble to main February 28, 2025 16:45
@joanise joanise merged commit 89aa16c into main Feb 28, 2025
8 checks passed
@joanise joanise deleted the dev.ej/summarize-g2p-errors branch February 28, 2025 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant