icefog72 commited on
Commit
88958f0
1 Parent(s): 58b4eaa

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +42 -0
README.md CHANGED
@@ -140,6 +140,48 @@ The following models were included in the merge:
140
  * [grimjim/kukulemon-7B](https://huggingface.co/grimjim/kukulemon-7B)
141
  * [Nitral-AI/Kunocchini-7b-128k-test](https://huggingface.co/Nitral-AI/Kunocchini-7b-128k-test)
142
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
143
  ### Configuration
144
 
145
  The following YAML configuration was used to produce this model:
 
140
  * [grimjim/kukulemon-7B](https://huggingface.co/grimjim/kukulemon-7B)
141
  * [Nitral-AI/Kunocchini-7b-128k-test](https://huggingface.co/Nitral-AI/Kunocchini-7b-128k-test)
142
 
143
+ ## How to download, including from branches
144
+
145
+ ### From the command line
146
+
147
+ I recommend using the `huggingface-hub` Python library:
148
+
149
+ ```shell
150
+ pip3 install huggingface-hub
151
+ ```
152
+
153
+ To download the `main` branch to a folder called `Kunokukulemonchini-7b`:
154
+
155
+ ```shell
156
+ mkdir icefog72/Kunokukulemonchini-7b
157
+ huggingface-cli download icefog72/Kunokukulemonchini-7b --local-dir Kunokukulemonchini-7b --local-dir-use-symlinks False
158
+ ```
159
+
160
+ <details>
161
+ <summary>More advanced huggingface-cli download usage</summary>
162
+
163
+ If you remove the `--local-dir-use-symlinks False` parameter, the files will instead be stored in the central Hugging Face cache directory (default location on Linux is: `~/.cache/huggingface`), and symlinks will be added to the specified `--local-dir`, pointing to their real location in the cache. This allows for interrupted downloads to be resumed, and allows you to quickly clone the repo to multiple places on disk without triggering a download again. The downside, and the reason why I don't list that as the default option, is that the files are then hidden away in a cache folder and it's harder to know where your disk space is being used, and to clear it up if/when you want to remove a download model.
164
+
165
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
166
+
167
+ For more documentation on downloading with `huggingface-cli`, please see: [HF -> Hub Python Library -> Download files -> Download from the CLI](https://huggingface.co/docs/huggingface_hub/guides/download#download-from-the-cli).
168
+
169
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
170
+
171
+ ```shell
172
+ pip3 install hf_transfer
173
+ ```
174
+
175
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
176
+
177
+ ```shell
178
+ mkdir FOLDERNAME
179
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download MODEL --local-dir FOLDERNAME --local-dir-use-symlinks False
180
+ ```
181
+
182
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
183
+ </details>
184
+
185
  ### Configuration
186
 
187
  The following YAML configuration was used to produce this model: