icefog72 commited on
Commit
001beaf
1 Parent(s): a84600d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +40 -0
README.md CHANGED
@@ -53,6 +53,46 @@ The following models were included in the merge:
53
 
54
  The following YAML configuration was used to produce this model:
55
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
56
  ```yaml
57
  models:
58
  - model: NeuralBeagleJaskier
 
53
 
54
  The following YAML configuration was used to produce this model:
55
 
56
+
57
+
58
+ I recommend using the `huggingface-hub` Python library:
59
+
60
+ ```shell
61
+ pip3 install huggingface-hub
62
+ ```
63
+
64
+ To download the `main` branch to a folder called `IceCocoaRP-7b`:
65
+
66
+ ```shell
67
+ mkdir IceCocoaRP-7b
68
+ huggingface-cli download icefog72/IceCocoaRP-7b --local-dir IceCocoaRP-7b --local-dir-use-symlinks False
69
+ ```
70
+
71
+ <details>
72
+ <summary>More advanced huggingface-cli download usage</summary>
73
+
74
+ 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.
75
+
76
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
77
+
78
+ 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).
79
+
80
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
81
+
82
+ ```shell
83
+ pip3 install hf_transfer
84
+ ```
85
+
86
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
87
+
88
+ ```shell
89
+ mkdir FOLDERNAME
90
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download MODEL --local-dir FOLDERNAME --local-dir-use-symlinks False
91
+ ```
92
+
93
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
94
+ </details>
95
+
96
  ```yaml
97
  models:
98
  - model: NeuralBeagleJaskier