GGUF
English
causal-lm
8 papers
maddes8cht commited on
Commit
1c53a4a
1 Parent(s): efe443f

"Update README.md"

Browse files
Files changed (1) hide show
  1. README.md +168 -0
README.md ADDED
@@ -0,0 +1,168 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: cc-by-sa-4.0
3
+ datasets:
4
+ - tiiuae/falcon-refinedweb
5
+ - togethercomputer/RedPajama-Data-1T
6
+ - CarperAI/pilev2-dev
7
+ - bigcode/starcoderdata
8
+ - allenai/peS2o
9
+ language:
10
+ - en
11
+ tags:
12
+ - causal-lm
13
+ extra_gated_fields:
14
+ Name: text
15
+ Email: text
16
+ Country: text
17
+ Organization or Affiliation: text
18
+ I ALLOW Stability AI to email me about new model releases: checkbox
19
+ ---
20
+ [![banner](https://maddes8cht.github.io/assets/buttons/Huggingface-banner.jpg)]()
21
+
22
+ I'm constantly enhancing these model descriptions to provide you with the most relevant and comprehensive information
23
+
24
+ # stablelm-3b-4e1t - GGUF
25
+ - Model creator: [stabilityai](https://huggingface.co/stabilityai)
26
+ - Original model: [stablelm-3b-4e1t](https://huggingface.co/stabilityai/stablelm-3b-4e1t)
27
+
28
+
29
+
30
+
31
+
32
+ # About GGUF format
33
+
34
+ `gguf` is the current file format used by the [`ggml`](https://github.com/ggerganov/ggml) library.
35
+ A growing list of Software is using it and can therefore use this model.
36
+ The core project making use of the ggml library is the [llama.cpp](https://github.com/ggerganov/llama.cpp) project by Georgi Gerganov
37
+
38
+ # Quantization variants
39
+
40
+ There is a bunch of quantized files available to cater to your specific needs. Here's how to choose the best option for you:
41
+
42
+ # Legacy quants
43
+
44
+ Q4_0, Q4_1, Q5_0, Q5_1 and Q8 are `legacy` quantization types.
45
+ Nevertheless, they are fully supported, as there are several circumstances that cause certain model not to be compatible with the modern K-quants.
46
+ ## Note:
47
+ Now there's a new option to use K-quants even for previously 'incompatible' models, although this involves some fallback solution that makes them not *real* K-quants. More details can be found in affected model descriptions.
48
+ (This mainly refers to Falcon 7b and Starcoder models)
49
+
50
+ # K-quants
51
+
52
+ K-quants are designed with the idea that different levels of quantization in specific parts of the model can optimize performance, file size, and memory load.
53
+ So, if possible, use K-quants.
54
+ With a Q6_K, you'll likely find it challenging to discern a quality difference from the original model - ask your model two times the same question and you may encounter bigger quality differences.
55
+
56
+
57
+
58
+
59
+ ---
60
+
61
+ # Original Model Card:
62
+ # `StableLM-3B-4E1T`
63
+
64
+ ## Model Description
65
+
66
+ `StableLM-3B-4E1T` is a 3 billion parameter decoder-only language model pre-trained on 1 trillion tokens of diverse English and code datasets for 4 epochs.
67
+
68
+ ## Usage
69
+
70
+ Get started generating text with `StableLM-3B-4E1T` by using the following code snippet:
71
+
72
+ ```python
73
+ from transformers import AutoModelForCausalLM, AutoTokenizer
74
+ tokenizer = AutoTokenizer.from_pretrained("stabilityai/stablelm-3b-4e1t")
75
+ model = AutoModelForCausalLM.from_pretrained(
76
+ "stabilityai/stablelm-3b-4e1t",
77
+ trust_remote_code=True,
78
+ torch_dtype="auto",
79
+ )
80
+ model.cuda()
81
+ inputs = tokenizer("The weather is always wonderful", return_tensors="pt").to("cuda")
82
+ tokens = model.generate(
83
+ **inputs,
84
+ max_new_tokens=64,
85
+ temperature=0.75,
86
+ top_p=0.95,
87
+ do_sample=True,
88
+ )
89
+ print(tokenizer.decode(tokens[0], skip_special_tokens=True))
90
+ ```
91
+
92
+ ## Model Details
93
+
94
+ * **Developed by**: [Stability AI](https://stability.ai/)
95
+ * **Model type**: `StableLM-3B-4E1T` models are auto-regressive language models based on the transformer decoder architecture.
96
+ * **Language(s)**: English
97
+ * **Library**: [GPT-NeoX](https://github.com/EleutherAI/gpt-neox)
98
+ * **License**: Model checkpoints are licensed under the Creative Commons license ([CC BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/)). Under this license, you must give [credit](https://creativecommons.org/licenses/by/4.0/#) to Stability AI, provide a link to the license, and [indicate if changes were made](https://creativecommons.org/licenses/by/4.0/#). You may do so in any reasonable manner, but not in any way that suggests the Stability AI endorses you or your use.
99
+ * **Contact**: For questions and comments about the model, please email `lm@stability.ai`
100
+
101
+ ### Model Architecture
102
+
103
+ The model is a decoder-only transformer similar to the LLaMA ([Touvron et al., 2023](https://arxiv.org/abs/2307.09288)) architecture with the following modifications:
104
+
105
+ | Parameters | Hidden Size | Layers | Heads | Sequence Length |
106
+ |----------------|-------------|--------|-------|-----------------|
107
+ | 2,795,443,200 | 2560 | 32 | 32 | 4096 |
108
+
109
+ * **Position Embeddings**: Rotary Position Embeddings ([Su et al., 2021](https://arxiv.org/abs/2104.09864)) applied to the first 25% of head embedding dimensions for improved throughput following [Black et al. (2022)](https://arxiv.org/pdf/2204.06745.pdf).
110
+ * **Normalization**: LayerNorm ([Ba et al., 2016](https://arxiv.org/abs/1607.06450)) with learned bias terms as opposed to RMSNorm ([Zhang & Sennrich, 2019](https://arxiv.org/abs/1910.07467)).
111
+ * **Tokenizer**: GPT-NeoX ([Black et al., 2022](https://arxiv.org/abs/2204.06745)).
112
+
113
+ ## Training
114
+
115
+ For complete dataset and training details, please see the [StableLM-3B-4E1T Technical Report](https://stability.wandb.io/stability-llm/stable-lm/reports/StableLM-3B-4E1T--VmlldzoyMjU4?accessToken=u3zujipenkx5g7rtcj9qojjgxpconyjktjkli2po09nffrffdhhchq045vp0wyfo).
116
+
117
+ ### Training Dataset
118
+
119
+ The dataset is comprised of a filtered mixture of open-source large-scale datasets available on the [HuggingFace Hub](https://huggingface.co/datasets): Falcon RefinedWeb extract ([Penedo et al., 2023](https://huggingface.co/datasets/tiiuae/falcon-refinedweb)), RedPajama-Data ([Together Computer., 2023](https://github.com/togethercomputer/RedPajama-Data)) and The Pile ([Gao et al., 2020](https://arxiv.org/abs/2101.00027)) both without the *Books3* subset, and StarCoder ([Li et al., 2023](https://arxiv.org/abs/2305.06161)).
120
+
121
+ * Given the large amount of web data, we recommend fine-tuning the base StableLM-3B-4E1T for your downstream tasks.
122
+
123
+ ### Training Procedure
124
+
125
+ The model is pre-trained on the aforementioned datasets in `bfloat16` precision, optimized with AdamW, and trained using the NeoX tokenizer with a vocabulary size of 50,257. We outline the complete hyperparameters choices in the project's [GitHub repository - config](https://github.com/Stability-AI/StableLM/blob/main/configs/stablelm-3b-4e1t.yml).
126
+
127
+ ### Training Infrastructure
128
+
129
+ * **Hardware**: `StableLM-3B-4E1T` was trained on the Stability AI cluster across 256 NVIDIA A100 40GB GPUs (AWS P4d instances). Training began on August 23, 2023, and took approximately 30 days to complete.
130
+
131
+ * **Software**: We use a fork of `gpt-neox` ([EleutherAI, 2021](https://github.com/EleutherAI/gpt-neox)), train under 2D parallelism (Data and Tensor Parallel) with ZeRO-1 ([Rajbhandari et al., 2019](https://arxiv.org/abs/1910.02054v3)), and rely on flash-attention as well as SwiGLU and Rotary Embedding kernels from FlashAttention-2 ([Dao et al., 2023](https://tridao.me/publications/flash2/flash2.pdf))
132
+
133
+ ## Use and Limitations
134
+
135
+ ### Intended Use
136
+
137
+ The model is intended to be used as a foundational base model for application-specific fine-tuning. Developers must evaluate and fine-tune the model for safe performance in downstream applications.
138
+
139
+ ### Limitations and Bias
140
+
141
+ As a base model, this model may exhibit unreliable, unsafe, or other undesirable behaviors that must be corrected through evaluation and fine-tuning prior to deployment. The pre-training dataset may have contained offensive or inappropriate content, even after applying data cleansing filters, which can be reflected in the model-generated text. We recommend that users exercise caution when using these models in production systems. Do not use the models if they are unsuitable for your application, or for any applications that may cause deliberate or unintentional harm to others.
142
+
143
+ ## How to Cite
144
+
145
+ ```bibtex
146
+ @misc{StableLM-3B-4E1T,
147
+ url={[https://huggingface.co/stabilityai/stablelm-3b-4e1t](https://huggingface.co/stabilityai/stablelm-3b-4e1t)},
148
+ title={StableLM 3B 4E1T},
149
+ author={Tow, Jonathan and Bellagente, Marco and Mahan, Dakota and Riquelme, Carlos}
150
+ }
151
+ ```
152
+
153
+ ***End of original Model File***
154
+ ---
155
+
156
+
157
+ ## Please consider to support my work
158
+ **Coming Soon:** I'm in the process of launching a sponsorship/crowdfunding campaign for my work. I'm evaluating Kickstarter, Patreon, or the new GitHub Sponsors platform, and I am hoping for some support and contribution to the continued availability of these kind of models. Your support will enable me to provide even more valuable resources and maintain the models you rely on. Your patience and ongoing support are greatly appreciated as I work to make this page an even more valuable resource for the community.
159
+
160
+ <center>
161
+
162
+ [![GitHub](https://maddes8cht.github.io/assets/buttons/github-io-button.png)](https://maddes8cht.github.io)
163
+ [![Stack Exchange](https://stackexchange.com/users/flair/26485911.png)](https://stackexchange.com/users/26485911)
164
+ [![GitHub](https://maddes8cht.github.io/assets/buttons/github-button.png)](https://github.com/maddes8cht)
165
+ [![HuggingFace](https://maddes8cht.github.io/assets/buttons/huggingface-button.png)](https://huggingface.co/maddes8cht)
166
+ [![Twitter](https://maddes8cht.github.io/assets/buttons/twitter-button.png)](https://twitter.com/maddes1966)
167
+
168
+ </center>