transformers/docs/source
Nicolas Patry db9dd09cf9
Adding AutomaticSpeechRecognitionPipeline. (#11337)
* Adding `AutomaticSpeechRecognitionPipeline`.

- Because we added everything to enable this pipeline, we probably
should add it to `transformers`.
- This PR tries to limit the scope and focuses only on the pipeline part
(what should go in, and out).
- The tests are very specific for S2T and Wav2vec2 to make sure both
architectures are supported by the pipeline. We don't use the mixin for
tests right now, because that requires more work in the `pipeline`
function (will be done in a follow up PR).
- Unsure about the "helper" function `ffmpeg_read`. It makes a lot of
  sense from a user perspective, it does not add any additional
dependencies (as in hard dependency, because users can always use their
own load mechanism). Meanwhile, it feels slightly clunky to have so much
optional preprocessing.
- The pipeline is not done to support streaming audio right now.

Future work:

- Add `automatic-speech-recognition` as a `task`. And add the
FeatureExtractor.from_pretrained within `pipeline` function.
- Add small models within tests
- Add the Mixin to tests.
- Make the logic between ForCTC vs ForConditionalGeneration better.

* Update tests/test_pipelines_automatic_speech_recognition.py

Co-authored-by: Lysandre Debut <lysandre@huggingface.co>

* Adding docs + main import + type checking + LICENSE.

* Doc style !.

* Fixing TYPE_HINT.

* Specifying waveform shape in the docs.

* Adding asserts + specify in the documentation the shape of the input
np.ndarray.

* Update src/transformers/pipelines/automatic_speech_recognition.py

Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com>

* Adding require to tests + move the `feature_extractor` doc.

Co-authored-by: Lysandre Debut <lysandre@huggingface.co>
Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com>
2021-04-30 11:54:08 +02:00
..
_static Document v4.5.1 2021-04-13 11:28:17 -04:00
imgs [Templates] Add template "call-for-model" markdown and "call-for-big-bird" markdown (#9921) 2021-02-05 15:47:54 +03:00
internal Instantiate model only once in pipeline (#10888) 2021-03-29 10:39:14 -04:00
main_classes Adding AutomaticSpeechRecognitionPipeline. (#11337) 2021-04-30 11:54:08 +02:00
model_doc Examples reorg (#11350) 2021-04-21 11:11:20 -04:00
add_new_model.rst Indent code block in the documentation (#11233) 2021-04-13 15:36:36 -04:00
benchmarks.rst Examples reorg (#11350) 2021-04-21 11:11:20 -04:00
bertology.rst Fix documentation links always pointing to master. (#9217) 2021-01-05 06:18:48 -05:00
community.md [Community notebooks] Add Wav2Vec notebook for creating captions for YT Clips (#11142) 2021-04-09 12:10:37 +05:30
conf.py added social thumbnail for docs (#11083) 2021-04-06 14:56:18 +02:00
contributing.md Update installation page and add contributing to the doc (#5084) 2020-06-17 14:01:10 -04:00
converting_tensorflow_models.rst Examples reorg (#11350) 2021-04-21 11:11:20 -04:00
custom_datasets.rst Rename NLP library to Datasets library (#10920) 2021-03-26 08:07:59 -04:00
examples.md per_device instead of per_gpu/error thrown when argument unknown (#4618) 2020-05-27 11:36:55 -04:00
fast_tokenizers.rst Documentation about loading a fast tokenizer within Transformers (#11029) 2021-04-05 10:51:16 -04:00
favicon.ico Adding usage examples for common tasks (#2850) 2020-02-25 13:48:24 -05:00
glossary.rst Indent code block in the documentation (#11233) 2021-04-13 15:36:36 -04:00
index.rst Update min versions in README and add Flax (#11472) 2021-04-28 09:10:06 -04:00
installation.md fix #1149 (#11493) 2021-04-28 11:16:41 -04:00
migration.md [docs] fix invalid class name (#11438) 2021-04-26 08:37:32 -07:00
model_sharing.rst Trainer push to hub (#11328) 2021-04-23 09:17:37 -04:00
model_summary.rst Examples reorg (#11350) 2021-04-21 11:11:20 -04:00
multilingual.rst Examples reorg (#11350) 2021-04-21 11:11:20 -04:00
notebooks.md Update notebooks (#3620) 2020-04-06 14:32:39 -04:00
perplexity.rst minor typo fix 2021-04-01 11:58:37 -06:00
philosophy.rst Minor documentation revisions from copyediting (#9266) 2020-12-23 10:15:49 -05:00
preprocessing.rst Minor documentation revisions from copyediting (#9266) 2020-12-23 10:15:49 -05:00
pretrained_models.rst GPT Neo few fixes (#10968) 2021-03-30 11:15:55 -04:00
quicktour.rst Finish Making Quick Tour respect the model object (#11467) 2021-04-27 10:04:12 -04:00
sagemaker.md Examples reorg (#11350) 2021-04-21 11:11:20 -04:00
serialization.rst Copyright (#8970) 2020-12-07 18:36:34 -05:00
task_summary.rst Examples reorg (#11350) 2021-04-21 11:11:20 -04:00
testing.rst [testing doc] bring doc up to date (#11359) 2021-04-21 08:51:00 -07:00
tokenizer_summary.rst Minor documentation revisions from copyediting (#9266) 2020-12-23 10:15:49 -05:00
training.rst [trainer] deepspeed integration (#9211) 2021-01-12 19:05:18 -08:00
troubleshooting.md [troubleshooting] add 2 points of reference to the offline mode (#11236) 2021-04-14 08:39:23 -07:00