icefog72 commited on
Commit
c27b690
·
verified ·
1 Parent(s): b055492

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +39 -0
README.md CHANGED
@@ -21,3 +21,42 @@ tags:
21
 
22
 
23
  [ko-fi To buy sweets for my cat :3](https://ko-fi.com/icefog72)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
 
22
 
23
  [ko-fi To buy sweets for my cat :3](https://ko-fi.com/icefog72)
24
+ ## Download
25
+
26
+ I recommend using the `huggingface-hub` Python library:
27
+
28
+ ```shell
29
+ pip3 install huggingface-hub
30
+ ```
31
+
32
+ To download the `main` branch to a folder called `IceWhiskeyRP-7b-6.5bpw-exl2`:
33
+
34
+ ```shell
35
+ mkdir IceWhiskeyRP-7b-6.5bpw-exl2
36
+ huggingface-cli download icefog72/IceWhiskeyRP-7b-6.5bpw-exl2 --local-dir IceWhiskeyRP-7b-6.5bpw-exl2 --local-dir-use-symlinks False
37
+ ```
38
+
39
+ <details>
40
+ <summary>More advanced huggingface-cli download usage</summary>
41
+
42
+ 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.
43
+
44
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
45
+
46
+ 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).
47
+
48
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
49
+
50
+ ```shell
51
+ pip3 install hf_transfer
52
+ ```
53
+
54
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
55
+
56
+ ```shell
57
+ mkdir FOLDERNAME
58
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download MODEL --local-dir FOLDERNAME --local-dir-use-symlinks False
59
+ ```
60
+
61
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
62
+ </details>