From d49b5c965a980a161c3da320e57238e983adea1a Mon Sep 17 00:00:00 2001
From: Jackmin801 <ongjackm@gmail.com>
Date: Tue, 19 Nov 2024 15:29:36 +0800
Subject: [PATCH] explainer about upload cmd

---
 README.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0a64ae97..026a77d7 100644
--- a/README.md
+++ b/README.md
@@ -170,5 +170,6 @@ python scripts/export_dcp.py @configs/10B/H100.toml --ckpt.path /path/to/save/co
 You can then upload the model to huggingface using huggingface-cli:
 ```bash
 # Usage:  huggingface-cli upload [repo_id] [local_path] [path_in_repo]
-huggingface-cli upload mymodel /path/to/save/converted_model . --private
+huggingface-cli upload username/mymodel /path/to/save/converted_model . --private
 ```
+The repo will be created if `repo_id` does not exist. The `--private` will create the repo as a private repo and cab ne ommited to create a publicly accessible repo.