Document state alignment and output format #454
Conversation
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
Add output format section to general help describing JSON fields (b, d, p, t, w). Add documentation to align help explaining when each level (words, phones, states) is produced based on options.
Add documentation to ps_alignment_t explaining the three-level hierarchy (words, phones, states), iteration methods, and entry fields. Clarify that score is acoustic log probability where higher (less negative) is better. Addresses: cmusphinx#370
Improve Alignment class docstring to explain three-level hierarchy and two iteration methods (flat and hierarchical). Improve AlignmentEntry docstring with clearer attribute documentation, frame-to-seconds conversion notes, and example showing output in seconds.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Improve documentation for alignment output format and options, making them discoverable via CLI help and library documentation.
CLI changes:
-phone_align, states with-state_align)C API changes:
ps_alignment_twith hierarchy explanation (words → phones → states)Python API changes:
Alignmentclass docstring explaining three levels and two iteration methodsAlignmentEntrydocstring with clearer attribute documentation and example showing seconds conversionAddresses #453
Addresses #370
Verification steps
pocketsphinx helpand verify output format is documentedpocketsphinx help alignand verify alignment levels are explainedtest_word_alignto confirm no regressions