Commit 46ed2b98 authored by Caroline Chen's avatar Caroline Chen Committed by Facebook GitHub Bot
Browse files

Update decoder pretrained lm docs (#2291)

Summary:
`build_docs` test is failing on CI with `ImportError: cannot import name 'environmentfilter' from 'jinja2'`, but with local build:

<img width="902" alt="Screen Shot 2022-03-25 at 4 02 53 PM" src="https://user-images.githubusercontent.com/16568633/160157472-c91ff9b2-a2be-4c5d-959e-53b9f45425c6.png">

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

Reviewed By: mthrok

Differential Revision: D35147098

Pulled By: carolineechen

fbshipit-source-id: 682b3800d0ed5c56b402d83f221136725051ba7e
parent 21c1ab7e
......@@ -25,10 +25,18 @@ Factory Function
----------------
lexicon_decoder
~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~
.. autoclass:: lexicon_decoder
Utility Function
----------------
download_pretrained_files
~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: download_pretrained_files
References
----------
......
......@@ -277,15 +277,17 @@ def download_pretrained_files(model: str) -> _PretrainedFiles:
Retrieves pretrained data files used for CTC decoder.
Args:
model (str): pretrained language model to download
model (str): pretrained language model to download.
Options: ["librispeech-3-gram", "librispeech-4-gram", "librispeech"]
Returns:
Object with the following attributes:
lm: path corresponding to downloaded language model, or None if model is not
associated with an lm
lexicon: path corresponding to downloaded lexicon file
tokens: path corresponding to downloaded tokens file
Object with the following attributes
lm:
path corresponding to downloaded language model, or `None` if the model is not associated with an lm
lexicon:
path corresponding to downloaded lexicon file
tokens:
path corresponding to downloaded tokens file
"""
files = _get_filenames(model)
......
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