From 3f5ccb183e3cfa755dea2dd2afd9abbf1a0f93b8 Mon Sep 17 00:00:00 2001
From: Julien Chaumond <chaumond@gmail.com>
Date: Mon, 16 Dec 2019 18:20:23 -0500
Subject: [PATCH] [doc] Clarify uploads

cf https://github.com/huggingface/transformers/commit/855ff0e91d8b3bd75a3b1c1316e2efd814373764#commitcomment-36452545
---
 README.md                    | 10 +++++-----
 docs/source/model_sharing.md | 12 ++++++------
 2 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index a5ae74a9ae..c33a65bdbb 100644
--- a/README.md
+++ b/README.md
@@ -464,21 +464,21 @@ transformers-cli upload ./path/to/pretrained_model/
 # ^^ Upload folder containing weights/tokenizer/config
 # saved via `.save_pretrained()`
 
-transformers-cli upload ./config.json [--filename foobar.json]
+transformers-cli upload ./config.json [--filename folder/foobar.json]
 
 # ^^ Upload a single file
-# (you can optionally override its filename)
+# (you can optionally override its filename, which can be nested inside a folder)
 ```
 
-Your model will then be accessible through its identifier:
+Your model will then be accessible through its identifier, a concatenation of your username and the folder name above:
 ```python
 "username/model_name"
 ```
 
 Anyone can load it from code:
 ```python
-tokenizer = AutoTokenizer.from_pretrained("username/model_name")
-model = AutoModel.from_pretrained("username/model_name")
+tokenizer = AutoTokenizer.from_pretrained("username/pretrained_model")
+model = AutoModel.from_pretrained("username/pretrained_model")
 ```
 
 Finally, list all your files on S3:
diff --git a/docs/source/model_sharing.md b/docs/source/model_sharing.md
index b9c722b10f..95baafb575 100644
--- a/docs/source/model_sharing.md
+++ b/docs/source/model_sharing.md
@@ -15,21 +15,21 @@ transformers-cli upload ./path/to/pretrained_model/
 # ^^ Upload folder containing weights/tokenizer/config
 # saved via `.save_pretrained()`
 
-transformers-cli upload ./config.json [--filename foobar.json]
+transformers-cli upload ./config.json [--filename folder/foobar.json]
 
 # ^^ Upload a single file
-# (you can optionally override its filename)
+# (you can optionally override its filename, which can be nested inside a folder)
 ```
 
-Your model will then be accessible through its identifier:
+Your model will then be accessible through its identifier, a concatenation of your username and the folder name above:
 ```python
-"username/model_name"
+"username/pretrained_model"
 ```
 
 Anyone can load it from code:
 ```python
-tokenizer = AutoTokenizer.from_pretrained("username/model_name")
-model = AutoModel.from_pretrained("username/model_name")
+tokenizer = AutoTokenizer.from_pretrained("username/pretrained_model")
+model = AutoModel.from_pretrained("username/pretrained_model")
 ```
 
 Finally, list all your files on S3: