SUMIN/HuggingFace_transformer
1
0
Fork 0
Code Issues Pull Requests Actions 7 Packages Projects Releases Wiki Activity

correct spelling in README (#19092)

Browse Source
This commit is contained in:
flozi00
2022-09-19 19:51:43 +02:00
committed by GitHub
parent e7206ceab9
commit 6be338f1b9
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/README.md
View File

@@ -312,13 +312,13 @@ easily.
# Testing documentation examples # Testing documentation examples
Good documentation oftens comes with an example of how a specific function or class should be used. Good documentation often comes with an example of how a specific function or class should be used.
Each model class should contain at least one example showcasing Each model class should contain at least one example showcasing
how to use this model class in inference. *E.g.* the class [Wav2Vec2ForCTC](https://huggingface.co/docs/transformers/model_doc/wav2vec2#transformers.Wav2Vec2ForCTC) how to use this model class in inference. *E.g.* the class [Wav2Vec2ForCTC](https://huggingface.co/docs/transformers/model_doc/wav2vec2#transformers.Wav2Vec2ForCTC)
includes an example of how to transcribe speech to text in the includes an example of how to transcribe speech to text in the
[docstring of its forward function](https://huggingface.co/docs/transformers/model_doc/wav2vec2#transformers.Wav2Vec2ForCTC.forward). [docstring of its forward function](https://huggingface.co/docs/transformers/model_doc/wav2vec2#transformers.Wav2Vec2ForCTC.forward).
## Writing documenation examples ## Writing documentation examples
The syntax for Example docstrings can look as follows: The syntax for Example docstrings can look as follows: