maddes8cht commited on
Commit
8f481b2
1 Parent(s): 0c4ec4f

"Update README.md"

Browse files
Files changed (1) hide show
  1. README.md +120 -0
README.md ADDED
@@ -0,0 +1,120 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ datasets:
4
+ - teknium/openhermes
5
+ language:
6
+ - en
7
+ metrics:
8
+ - accuracy
9
+ library_name: transformers
10
+ pipeline_tag: question-answering
11
+ tags:
12
+ - General
13
+ ---
14
+ [![banner](https://maddes8cht.github.io/assets/buttons/Huggingface-banner.jpg)]()
15
+
16
+ I'm constantly enhancing these model descriptions to provide you with the most relevant and comprehensive information
17
+
18
+ # StableHermes-3b - GGUF
19
+ - Model creator: [cxllin](https://huggingface.co/cxllin)
20
+ - Original model: [StableHermes-3b](https://huggingface.co/cxllin/StableHermes-3b)
21
+
22
+ # StableLM
23
+ This is a Model based on StableLM. Stablelm is a familiy of Language Models by Stability AI.
24
+
25
+ ## Note:
26
+ Current (as of. 2023-11-15) implementations of Llama.cpp only support GPU offloading up to 34 Layers with these StableLM Models.
27
+ The model will crash immediately if -ngl is larger than 34.
28
+ The model works fine however without any gpu acceleration.
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
+ # StableHermes-3b by cxllin
63
+
64
+ ![StableHermes-3b Model Image](https://files.oaiusercontent.com/file-0vo6R0dT0BoAbKSFLTR0Xj5y?se=2023-10-31T16%3A43%3A57Z&sp=r&sv=2021-08-06&sr=b&rscc=max-age%3D31536000%2C%20immutable&rscd=attachment%3B%20filename%3Ddaec119b-4177-442c-beab-b75992106ec6.webp&sig=4q/al9442fQZFLR4CC99/pvdY9A42hcOQqGsOUgbiiE%3D)
65
+
66
+ ## Overview
67
+
68
+ StableHermes-3b is an advanced 3 billion parameter language model fine-tuned on the expansive OpenHermes dataset. This dataset boasts 242,000 entries primarily sourced from GPT-4 generated data, encompassing a variety of open datasets from the broader AI landscape. As an enhancement of the GPT-NeoX family, StableHermes-3b is specifically designed to provide accurate and detailed insights across a myriad of domains.
69
+
70
+ ## Key Features
71
+
72
+ - **3 Billion Parameters:** State-of-the-art architecture emphasizing precision and detail.
73
+ - **Diverse Training Data:** Benefits from entries like GPTeacher datasets, WizardLM, Airoboros GPT-4, Camel-AI's domain expert datasets, and more.
74
+ - **Open Source Dataset:** OpenHermes is one of the first fine-tunes of the Hermes dataset that has an entirely open-source dataset.
75
+ - **Advanced Transformer Decoder Architecture:** Based on the GPT-NeoX's decoder-only language model structure.
76
+
77
+ ## Usage
78
+
79
+ To leverage StableHermes-3b for generating insights or responses, you can use the following code snippet:
80
+
81
+ ```python
82
+ from transformers import AutoModelForCausalLM, AutoTokenizer
83
+
84
+ tokenizer = AutoTokenizer.from_pretrained("cxllin/StableHermes-3b")
85
+ model = AutoModelForCausalLM.from_pretrained(
86
+ "cxllin/StableHermes-3b",
87
+ trust_remote_code=True,
88
+ torch_dtype="auto",
89
+ )
90
+ model.cuda()
91
+ inputs = tokenizer("Describe the potential implications of quantum computing on the future of cybersecurity.", return_tensors="pt").to("cuda")
92
+ tokens = model.generate(
93
+ **inputs,
94
+ max_new_tokens=64,
95
+ temperature=0.75,
96
+ top_p=0.95,
97
+ do_sample=True,
98
+ )
99
+ print(tokenizer.decode(tokens[0], skip_special_tokens=True))
100
+ ```
101
+
102
+ # Training Eval
103
+ ![StableHermes](https://cdn.discordapp.com/attachments/1168701768876695603/1168954926639091825/tl.jpg?ex=6553a51c&is=6541301c&hm=0e23e7fbffdc3825f6eb9180a33c0999a1c0d15da6b6ee991892f60b946a7db0&)
104
+
105
+ ***End of original Model File***
106
+ ---
107
+
108
+
109
+ ## Please consider to support my work
110
+ **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.
111
+
112
+ <center>
113
+
114
+ [![GitHub](https://maddes8cht.github.io/assets/buttons/github-io-button.png)](https://maddes8cht.github.io)
115
+ [![Stack Exchange](https://stackexchange.com/users/flair/26485911.png)](https://stackexchange.com/users/26485911)
116
+ [![GitHub](https://maddes8cht.github.io/assets/buttons/github-button.png)](https://github.com/maddes8cht)
117
+ [![HuggingFace](https://maddes8cht.github.io/assets/buttons/huggingface-button.png)](https://huggingface.co/maddes8cht)
118
+ [![Twitter](https://maddes8cht.github.io/assets/buttons/twitter-button.png)](https://twitter.com/maddes1966)
119
+
120
+ </center>