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

Update CTC Hypothesis docs #2117

Closed
wants to merge 2 commits into from
Closed

Conversation

carolineechen
Copy link
Contributor

add documentaion for CTC decoder Hypothesis and include it in docs

Copy link
Collaborator

@mthrok mthrok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

nit: KenLMLexiconDecoder.__call__'s return type signature is torchaudio.prototype.ctc_decoder.ctc_decoder.Hypothesis so you might want to overwrite it.

https://498852-90321822-gh.circle-artifacts.com/0/docs/prototype.ctc_decoder.html#torchaudio.prototype.ctc_decoder.KenLMLexiconDecoder.__call__



Hypothesis = namedtuple("Hypothesis", ["tokens", "words", "score"])
class Hypothesis(NamedTuple):
r"""Represents hypothesis generated by CTC beam search decoder ``KenLMLexiconDecoder``.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit:

Suggested change
r"""Represents hypothesis generated by CTC beam search decoder ``KenLMLexiconDecoder``.
r"""Represents hypothesis generated by CTC beam search decoder :py:func`KenLMLexiconDecoder`.

@facebook-github-bot
Copy link
Contributor

@carolineechen has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

xiaohui-zhang pushed a commit to xiaohui-zhang/audio that referenced this pull request May 4, 2022
Summary:
add documentaion for CTC decoder `Hypothesis` and include it in docs

Pull Request resolved: pytorch#2117

Reviewed By: mthrok

Differential Revision: D33370381

Pulled By: carolineechen

fbshipit-source-id: cf6501a499e5303cda0410f733f0fab4e1c39aff
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants