Skip to content

Commit cebb96f

Browse files
Add more subsections to main doc (#11758)
* add headers to main doc * Apply suggestions from code review * update * upload
1 parent da7e73b commit cebb96f

File tree

7 files changed

+12
-8
lines changed

7 files changed

+12
-8
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ Min, Patrick Lewis, Ledell Wu, Sergey Edunov, Danqi Chen, and Wen-tau Yih.
256256
1. **[XLSR-Wav2Vec2](https://huggingface.co/transformers/model_doc/xlsr_wav2vec2.html)** (from Facebook AI) released with the paper [Unsupervised Cross-Lingual Representation Learning For Speech Recognition](https://arxiv.org/abs/2006.13979) by Alexis Conneau, Alexei Baevski, Ronan Collobert, Abdelrahman Mohamed, Michael Auli.
257257
1. Want to contribute a new model? We have added a **detailed guide and templates** to guide you in the process of adding a new model. You can find them in the [`templates`](./templates) folder of the repository. Be sure to check the [contributing guidelines](./CONTRIBUTING.md) and contact the maintainers or open an issue to collect feedbacks before starting your PR.
258258

259-
To check if each model has an implementation in Flax, PyTorch or TensorFlow, or has an associated tokenizer backed by the 🤗 Tokenizers library, refer to [this table](https://huggingface.co/transformers/index.html#bigtable).
259+
To check if each model has an implementation in Flax, PyTorch or TensorFlow, or has an associated tokenizer backed by the 🤗 Tokenizers library, refer to [this table](https://huggingface.co/transformers/index.html#supported-frameworks).
260260

261261
These implementations have been tested on several datasets (see the example scripts) and should match the performance of the original implementations. You can find more details on performance in the Examples section of the [documentation](https://huggingface.co/transformers/examples.html).
262262

docs/source/index.rst

+6-2
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,10 @@ The documentation is organized in five parts:
8484
- **INTERNAL HELPERS** for the classes and functions we use internally.
8585

8686
The library currently contains Jax, PyTorch and Tensorflow implementations, pretrained model weights, usage scripts and
87-
conversion utilities for the following models:
87+
conversion utilities for the following models.
88+
89+
Supported models
90+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8891

8992
..
9093
This list is updated automatically from the README with `make fix-copies`. Do not update manually!
@@ -267,7 +270,8 @@ conversion utilities for the following models:
267270
Conneau, Alexei Baevski, Ronan Collobert, Abdelrahman Mohamed, Michael Auli.
268271

269272

270-
.. _bigtable:
273+
Supported frameworks
274+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
271275

272276
The table below represents the current support in the library for each of those models, whether they have a Python
273277
tokenizer (called "slow"). A "fast" tokenizer backed by the 🤗 Tokenizers library, whether they have support in Jax (via

examples/pytorch/question-answering/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Based on the script [`run_qa.py`](https://github.com/huggingface/transformers/bl
2020

2121
**Note:** This script only works with models that have a fast tokenizer (backed by the 🤗 Tokenizers library) as it
2222
uses special features of those tokenizers. You can check if your favorite model has a fast tokenizer in
23-
[this table](https://huggingface.co/transformers/index.html#bigtable), if it doesn't you can still use the old version
23+
[this table](https://huggingface.co/transformers/index.html#supported-frameworks), if it doesn't you can still use the old version
2424
of the script.
2525

2626
The old version of this script can be found [here](https://github.com/huggingface/transformers/tree/master/examples/legacy/question-answering).

examples/pytorch/question-answering/run_qa.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ def main():
304304
if not isinstance(tokenizer, PreTrainedTokenizerFast):
305305
raise ValueError(
306306
"This example script only works for models that have a fast tokenizer. Checkout the big table of models "
307-
"at https://huggingface.co/transformers/index.html#bigtable to find the model types that meet this "
307+
"at https://huggingface.co/transformers/index.html#supported-frameworks to find the model types that meet this "
308308
"requirement"
309309
)
310310

examples/pytorch/token-classification/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ python run_ner.py \
5252

5353
**Note:** This script only works with models that have a fast tokenizer (backed by the 🤗 Tokenizers library) as it
5454
uses special features of those tokenizers. You can check if your favorite model has a fast tokenizer in
55-
[this table](https://huggingface.co/transformers/index.html#bigtable), if it doesn't you can still use the old version
55+
[this table](https://huggingface.co/transformers/index.html#supported-frameworks), if it doesn't you can still use the old version
5656
of the script.
5757

5858
## Old version of the script

examples/pytorch/token-classification/run_ner.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ def get_label_list(labels):
306306
if not isinstance(tokenizer, PreTrainedTokenizerFast):
307307
raise ValueError(
308308
"This example script only works for models that have a fast tokenizer. Checkout the big table of models "
309-
"at https://huggingface.co/transformers/index.html#bigtable to find the model types that meet this "
309+
"at https://huggingface.co/transformers/index.html#supported-frameworks to find the model types that meet this "
310310
"requirement"
311311
)
312312

utils/check_copies.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ def check_model_list_copy(overwrite=False, max_per_line=119):
302302
rst_list, start_index, end_index, lines = _find_text_in_file(
303303
filename=os.path.join(PATH_TO_DOCS, "index.rst"),
304304
start_prompt=" This list is updated automatically from the README",
305-
end_prompt=".. _bigtable:",
305+
end_prompt="Supported frameworks",
306306
)
307307
md_list = get_model_list()
308308
converted_list = convert_to_rst(md_list, max_per_line=max_per_line)

0 commit comments

Comments
 (0)