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

[docs] Indent ordered list in add_new_model.md (#29796)

Browse Source
This commit is contained in:
Michael
2024-03-26 20:03:39 +08:00
committed by GitHub
parent de81a677c4
commit b9ceb03df8
1 changed files with 43 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/en/add_new_model.md
View File

@@ -759,7 +759,7 @@ In case you are using Windows, you should replace `RUN_SLOW=1` with `SET RUN_SLO
</Tip> </Tip>
Second, all features that are special to *brand_new_bert* should be tested additionally in a separate test under Second, all features that are special to *brand_new_bert* should be tested additionally in a separate test under
`BrandNewBertModelTester`/``BrandNewBertModelTest`. This part is often forgotten but is extremely useful in two `BrandNewBertModelTester`/`BrandNewBertModelTest`. This part is often forgotten but is extremely useful in two
ways: ways:
- It helps to transfer the knowledge you have acquired during the model addition to the community by showing how the - It helps to transfer the knowledge you have acquired during the model addition to the community by showing how the
@@ -776,7 +776,7 @@ It is very important to find/extract the original tokenizer file and to manage t
Transformers' implementation of the tokenizer. Transformers' implementation of the tokenizer.
To ensure that the tokenizer works correctly, it is recommended to first create a script in the original repository To ensure that the tokenizer works correctly, it is recommended to first create a script in the original repository
that inputs a string and returns the `input_ids``. It could look similar to this (in pseudo-code): that inputs a string and returns the `input_ids`. It could look similar to this (in pseudo-code):
```python ```python
input_str = "This is a long example input string containing special characters .$?-, numbers 2872 234 12 and words." input_str = "This is a long example input string containing special characters .$?-, numbers 2872 234 12 and words."
@@ -827,7 +827,7 @@ the community to add some *Tips* to show how the model should be used. Don't hes
regarding the docstrings. regarding the docstrings.
Next, make sure that the docstring added to `src/transformers/models/brand_new_bert/modeling_brand_new_bert.py` is Next, make sure that the docstring added to `src/transformers/models/brand_new_bert/modeling_brand_new_bert.py` is
correct and included all necessary inputs and outputs. We have a detailed guide about writing documentation and our docstring format [here](writing-documentation). It is always to good to remind oneself that documentation should correct and included all necessary inputs and outputs. We have a detailed guide about writing documentation and our docstring format [here](writing-documentation). It is always good to remind oneself that documentation should
be treated at least as carefully as the code in 🤗 Transformers since the documentation is usually the first contact be treated at least as carefully as the code in 🤗 Transformers since the documentation is usually the first contact
point of the community with the model. point of the community with the model.