[DOCS] Fix documentation of the quality scorer#27
Merged
mgaido91 merged 7 commits intohlt-mt:mainfrom Mar 4, 2026
Merged
Conversation
…rovide some minimal context Updated reference and transcript file names in README.
Updated reference and transcript file names in the usage example and adjusted help text for clarity.
mgaido91
reviewed
Mar 3, 2026
Contributor
mgaido91
left a comment
mgaido91
left a comment
There was a problem hiding this comment.
Thank you, just a few comments to properly document both options, so that users can choose the preferred one. Thanks for your contribution!
Co-authored-by: Marco Gaido <marcogaido91@gmail.com>
Updated references in README for simulstream commands and added clarification on audio definitions.
… YAML as suggested Updated command line arguments for the score_quality script to use new reference and transcript file names, and added an audio definition option.
mgaido91
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This solves #23
The changes in this PR are composed of tiny modifications to the examples and docs in the main README.md of SimulStream as well as in the
score_quality.pyfile. The intention here is to demonstrate that the stem of the providedtranscriptsandreferencesfiles need to be identically named in the current scorer implementation when no audio definition YAML is provided.Currently, the actual names of the transcript and reference provided are not very descriptive and should probably be modified further based on feedback.
An alternative approach would be to revise the scorer with some kind of structural assumption built-in regarding the ordering of files provided to as transcripts and references. However, this just opens up the scorer to a different kind of user error and doesn't seem like a meaningful fix.