icefog72 commited on
Commit
7ea0bdf
1 Parent(s): 5051fd0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +39 -0
README.md CHANGED
@@ -158,6 +158,45 @@ The following models were included in the merge:
158
  * [LeroyDyer/Mixtral_AI_Cyber_3.m1](https://huggingface.co/LeroyDyer/Mixtral_AI_Cyber_3.m1)
159
  * [Undi95/BigL-7B](https://huggingface.co/Undi95/BigL-7B)
160
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
161
  ### Configuration
162
 
163
  The following YAML configuration was used to produce this model:
 
158
  * [LeroyDyer/Mixtral_AI_Cyber_3.m1](https://huggingface.co/LeroyDyer/Mixtral_AI_Cyber_3.m1)
159
  * [Undi95/BigL-7B](https://huggingface.co/Undi95/BigL-7B)
160
 
161
+ ## How to download From the command line
162
+
163
+ I recommend using the `huggingface-hub` Python library:
164
+
165
+ ```shell
166
+ pip3 install huggingface-hub
167
+ ```
168
+
169
+ To download the `main` branch to a folder called `IceLemonTeaRP-32k-7b`:
170
+
171
+ ```shell
172
+ mkdir IceLemonTeaRP-32k-7b
173
+ huggingface-cli download icefog72/IceLemonTeaRP-32k-7b --local-dir IceLemonTeaRP-32k-7b --local-dir-use-symlinks False
174
+ ```
175
+
176
+ <details>
177
+ <summary>More advanced huggingface-cli download usage</summary>
178
+
179
+ 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.
180
+
181
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
182
+
183
+ 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).
184
+
185
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
186
+
187
+ ```shell
188
+ pip3 install hf_transfer
189
+ ```
190
+
191
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
192
+
193
+ ```shell
194
+ mkdir FOLDERNAME
195
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download MODEL --local-dir FOLDERNAME --local-dir-use-symlinks False
196
+ ```
197
+
198
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
199
+ </details>
200
  ### Configuration
201
 
202
  The following YAML configuration was used to produce this model: