icefog72 commited on
Commit
aa80574
1 Parent(s): a9feb40

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +45 -3
README.md CHANGED
@@ -1,12 +1,15 @@
1
  ---
2
- base_model: []
3
  library_name: transformers
4
  tags:
5
  - mergekit
6
  - merge
7
-
 
 
 
8
  ---
9
- # IceCoffeeTest11
10
 
11
  This is a merge of pre-trained language models created using [mergekit](https://github.com/cg123/mergekit).
12
 
@@ -24,6 +27,45 @@ The following models were included in the merge:
24
  ### Configuration
25
 
26
  The following YAML configuration was used to produce this model:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
27
 
28
  ```yaml
29
 
 
1
  ---
2
+ license: cc-by-nc-4.0
3
  library_name: transformers
4
  tags:
5
  - mergekit
6
  - merge
7
+ - alpaca
8
+ - mistral
9
+ - not-for-all-audiences
10
+ - nsfw
11
  ---
12
+ # IceCoffeeRP-7b-6.5bpw-exl2
13
 
14
  This is a merge of pre-trained language models created using [mergekit](https://github.com/cg123/mergekit).
15
 
 
27
  ### Configuration
28
 
29
  The following YAML configuration was used to produce this model:
30
+ ## How to download From the command line
31
+
32
+ I recommend using the `huggingface-hub` Python library:
33
+
34
+ ```shell
35
+ pip3 install huggingface-hub
36
+ ```
37
+
38
+ To download the `main` branch to a folder called `IceCoffeeRP-7b-6.5bpw-exl2`:
39
+
40
+ ```shell
41
+ mkdir IceCoffeeRP-7b-6.5bpw-exl2
42
+ huggingface-cli download icefog72/IceCoffeeRP-7b-6.5bpw-exl2 --local-dir IceCoffeeRP-7b-6.5bpw-exl2 --local-dir-use-symlinks False
43
+ ```
44
+
45
+ <details>
46
+ <summary>More advanced huggingface-cli download usage</summary>
47
+
48
+ 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.
49
+
50
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
51
+
52
+ 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).
53
+
54
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
55
+
56
+ ```shell
57
+ pip3 install hf_transfer
58
+ ```
59
+
60
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
61
+
62
+ ```shell
63
+ mkdir FOLDERNAME
64
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download MODEL --local-dir FOLDERNAME --local-dir-use-symlinks False
65
+ ```
66
+
67
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
68
+ </details>
69
 
70
  ```yaml
71