icefog72 commited on
Commit
4dfa40d
1 Parent(s): ac7b016

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +39 -1
README.md CHANGED
@@ -112,7 +112,7 @@ model-index:
112
  url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=icefog72/IceLatteRP-7b
113
  name: Open LLM Leaderboard
114
  ---
115
- # IceLatteRP
116
 
117
  This is a merge of pre-trained language models created using [mergekit](https://github.com/cg123/mergekit).
118
 
@@ -134,6 +134,44 @@ The following models were included in the merge:
134
  * IceCoffeeRP
135
  * WestIceLemonTeaRP
136
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
137
  ### Configuration
138
 
139
  The following YAML configuration was used to produce this model:
 
112
  url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=icefog72/IceLatteRP-7b
113
  name: Open LLM Leaderboard
114
  ---
115
+ # IceLatteRP-7b
116
 
117
  This is a merge of pre-trained language models created using [mergekit](https://github.com/cg123/mergekit).
118
 
 
134
  * IceCoffeeRP
135
  * WestIceLemonTeaRP
136
 
137
+ I recommend using the `huggingface-hub` Python library:
138
+
139
+ ```shell
140
+ pip3 install huggingface-hub
141
+ ```
142
+
143
+ To download the `main` branch to a folder called `IceLatteRP-7b`:
144
+
145
+ ```shell
146
+ mkdir IceLatteRP-7b
147
+ huggingface-cli download icefog72/IceLatteRP-7b --local-dir IceLatteRP-7b --local-dir-use-symlinks False
148
+ ```
149
+
150
+ <details>
151
+ <summary>More advanced huggingface-cli download usage</summary>
152
+
153
+ 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.
154
+
155
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
156
+
157
+ 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).
158
+
159
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
160
+
161
+ ```shell
162
+ pip3 install hf_transfer
163
+ ```
164
+
165
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
166
+
167
+ ```shell
168
+ mkdir FOLDERNAME
169
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download MODEL --local-dir FOLDERNAME --local-dir-use-symlinks False
170
+ ```
171
+
172
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
173
+ </details>
174
+
175
  ### Configuration
176
 
177
  The following YAML configuration was used to produce this model: