riaz.somc/transformers
1
0
Fork 0
mirror of https://github.com/huggingface/transformers.git synced 2025-07-23 22:38:58 +06:00
Code Issues Actions 31 Packages Projects Releases Wiki Activity

[doc] model sharing: mention README.md + tweaks

Browse Source 
cc @lysandrejik @thomwolf
This commit is contained in:
Julien Chaumond 2020-02-05 14:20:03 -05:00
parent 6bb6a01765
commit eae8ee0389
2 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -493,19 +493,22 @@ Your model will then be accessible through its identifier, a concatenation of yo
"username/pretrained_model" "username/pretrained_model"
``` ```
**Please add a README.md model card** to the repo under `model_cards/` with: model description, training params (dataset, preprocessing, hyperparameters), evaluation results, intended uses & limitations, etc.
Your model now has a page on huggingface.co/models 🔥
Anyone can load it from code: Anyone can load it from code:
```python ```python
tokenizer = AutoTokenizer.from_pretrained("username/pretrained_model") tokenizer = AutoTokenizer.from_pretrained("username/pretrained_model")
model = AutoModel.from_pretrained("username/pretrained_model") model = AutoModel.from_pretrained("username/pretrained_model")
``` ```
Finally, list all your files on S3: List all your files on S3:
```shell ```shell
transformers-cli s3 ls transformers-cli s3 ls
# List all your S3 objects.
``` ```
You can also delete files: You can also delete unneeded files:
```shell ```shell
transformers-cli s3 rm … transformers-cli s3 rm …

9
docs/source/model_sharing.md
View File

@ -26,19 +26,22 @@ Your model will then be accessible through its identifier, a concatenation of yo
"username/pretrained_model" "username/pretrained_model"
``` ```
**Please add a README.md model card** to the repo under `model_cards/` with: model description, training params (dataset, preprocessing, hyperparameters), evaluation results, intended uses & limitations, etc.
Your model now has a page on huggingface.co/models 🔥
Anyone can load it from code: Anyone can load it from code:
```python ```python
tokenizer = AutoTokenizer.from_pretrained("username/pretrained_model") tokenizer = AutoTokenizer.from_pretrained("username/pretrained_model")
model = AutoModel.from_pretrained("username/pretrained_model") model = AutoModel.from_pretrained("username/pretrained_model")
``` ```
Finally, list all your files on S3: List all your files on S3:
```shell ```shell
transformers-cli s3 ls transformers-cli s3 ls
# List all your S3 objects.
``` ```
You can also delete files: You can also delete unneeded files:
```shell ```shell
transformers-cli s3 rm … transformers-cli s3 rm …