Commit 3e4b961d authored by moto's avatar moto Committed by Facebook GitHub Bot
Browse files

Fix CTCDecoder doc (#2766)

Summary:
* Document `__call__` instead of `__init__`
* List CTCHypothesis first as it is used in combination with CTCDecoder
* Fix indentation of score method docstring

Pull Request resolved: https://github.com/pytorch/audio/pull/2766

Reviewed By: carolineechen

Differential Revision: D40349388

Pulled By: mthrok

fbshipit-source-id: 5e512e6c2b29d3533eb62d09b289154ccd1abf4c
parent 3a5a83d9
......@@ -24,7 +24,8 @@
Methods
=======
{%- for item in methods %}
{%- for item in members %}
{%- if not item.startswith('_') or item == "__call__" %}
{{ item | underline("-") }}
......@@ -32,12 +33,13 @@ Methods
.. automethod:: {{[fullname, item] | join('.')}}
{%- endif %}
{%- endfor %}
Support Structures
==================
{%- for item in ["CTCDecoderLM", "CTCDecoderLMState", "CTCHypothesis"] %}
{%- for item in ["CTCHypothesis", "CTCDecoderLM", "CTCDecoderLMState"] %}
{{ item | underline("-") }}
......
......@@ -173,8 +173,10 @@ class CTCDecoderLM(_LM):
Returns:
(CTCDecoderLMState, float)
CTCDecoderLMState: new LM state
float: score
CTCDecoderLMState:
new LM state
float:
score
"""
raise NotImplementedError
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment