From eae8ee038989aa4c13affe252002b8903f2996ca Mon Sep 17 00:00:00 2001 From: Julien Chaumond Date: Wed, 5 Feb 2020 14:20:03 -0500 Subject: [PATCH] [doc] model sharing: mention README.md + tweaks cc @lysandrejik @thomwolf --- README.md | 9 ++++++--- docs/source/model_sharing.md | 9 ++++++--- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2d31c823d3..abd4179413 100644 --- a/README.md +++ b/README.md @@ -493,19 +493,22 @@ Your model will then be accessible through its identifier, a concatenation of yo "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: ```python tokenizer = AutoTokenizer.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 transformers-cli s3 ls -# List all your S3 objects. ``` -You can also delete files: +You can also delete unneeded files: ```shell transformers-cli s3 rm … diff --git a/docs/source/model_sharing.md b/docs/source/model_sharing.md index 03ea4c3d80..4210ea21d2 100644 --- a/docs/source/model_sharing.md +++ b/docs/source/model_sharing.md @@ -26,19 +26,22 @@ Your model will then be accessible through its identifier, a concatenation of yo "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: ```python tokenizer = AutoTokenizer.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 transformers-cli s3 ls -# List all your S3 objects. ``` -You can also delete files: +You can also delete unneeded files: ```shell transformers-cli s3 rm …