aashish1904 commited on
Commit
bf996a0
Β·
verified Β·
1 Parent(s): 50c3155

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +158 -0
README.md ADDED
@@ -0,0 +1,158 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+ ---
3
+
4
+ license: apache-2.0
5
+ tags:
6
+ - merge
7
+ - mergekit
8
+ - lazymergekit
9
+ - vllm
10
+ - bfloat16
11
+ - llama
12
+ language:
13
+ - en
14
+ base_model:
15
+ - DreadPoor/Aspire-8B-model_stock
16
+ - DreadPoor/Heart_Stolen-8B-Model_Stock
17
+ - Khetterman/CursedMatrix-8B-v9
18
+ pipeline_tag: text-generation
19
+ library_name: transformers
20
+
21
+ ---
22
+
23
+ [![QuantFactory Banner](https://lh7-rt.googleusercontent.com/docsz/AD_4nXeiuCm7c8lEwEJuRey9kiVZsRn2W-b4pWlu3-X534V3YmVuVc2ZL-NXg2RkzSOOS2JXGHutDuyyNAUtdJI65jGTo8jT9Y99tMi4H4MqL44Uc5QKG77B0d6-JfIkZHFaUA71-RtjyYZWVIhqsNZcx8-OMaA?key=xt3VSDoCbmTY7o-cwwOFwQ)](https://hf.co/QuantFactory)
24
+
25
+
26
+ # QuantFactory/L3-Aspire-Heart-Matrix-8B-GGUF
27
+ This is quantized version of [ZeroXClem/L3-Aspire-Heart-Matrix-8B](https://huggingface.co/ZeroXClem/L3-Aspire-Heart-Matrix-8B) created using llama.cpp
28
+
29
+ # Original Model Card
30
+
31
+
32
+ # ZeroXClem/L3-Aspire-Heart-Matrix-8B
33
+
34
+ **ZeroXClem/L3-Aspire-Heart-Matrix-8B** is an experimental language model crafted by merging three high-quality 8B parameter models using the **Model Stock Merge** method. This synthesis leverages the unique strengths of Aspire, Heart Stolen, and CursedMatrix, creating a highly versatile and robust language model for a wide array of tasks.
35
+
36
+
37
+ ## 🌟 Model Details
38
+
39
+ - **Name:** `ZeroXClem/L3-Aspire-Heart-Matrix-8B`
40
+ - **Base Model:** `Khetterman/CursedMatrix-8B-v9`
41
+ - **Merge Method:** `Model Stock`
42
+ - **Parameter Count:** `8 billion`
43
+ - **Precision:** `bfloat16`
44
+
45
+ ---
46
+
47
+ ## πŸ“‹ Models Used in the Merge
48
+
49
+ 1. **[Aspire](https://huggingface.co/DreadPoor/Aspire-8B-model_stock)**
50
+ *Creator: DreadPoor*
51
+ Known for exceptional performance across diverse tasks and benchmarks.
52
+
53
+ 2. **[Heart Stolen](https://huggingface.co/DreadPoor/Heart_Stolen-8B-Model_Stock)**
54
+ *Creator: DreadPoor*
55
+ Renowned for its creative and empathetic prowess.
56
+
57
+ 3. **[CursedMatrix](https://huggingface.co/Khetterman/CursedMatrix-8B-v9)**
58
+ *Creator: Khetterman*
59
+ Famous for its depth and complexity, particularly in creative writing and roleplay.
60
+
61
+ ---
62
+
63
+ ## βš™οΈ Merge Configuration
64
+
65
+ ```yaml
66
+ models:
67
+ - model: DreadPoor/Aspire-8B-model_stock
68
+ - model: DreadPoor/Heart_Stolen-8B-Model_Stock
69
+ - model: Khetterman/CursedMatrix-8B-v9
70
+ merge_method: model_stock
71
+ base_model: Khetterman/CursedMatrix-8B-v9
72
+ normalize: false
73
+ int8_mask: true
74
+ dtype: bfloat16
75
+ ```
76
+
77
+ ---
78
+
79
+ ## 🌌 Model Capabilities
80
+
81
+ This powerful merger unites the best features of its components:
82
+
83
+ - **Aspire**: Outstanding performance across general tasks and benchmarks.
84
+ - **Heart Stolen**: Creativity and empathy at its core.
85
+ - **CursedMatrix**: Mastery of complex and dynamic text generation.
86
+
87
+ The resulting model excels in:
88
+
89
+ - 🌟 **General Question Answering**
90
+ - πŸ“ **Creative Writing**
91
+ - βœ‚οΈ **Summarizing Long-Form Content**
92
+ - 🎭 **Roleplay Scenarios**
93
+ - βœ… **Task Completion and Problem-Solving**
94
+
95
+ ---
96
+
97
+ ## πŸ› οΈ Usage
98
+
99
+ This model is compatible with popular inference frameworks, including:
100
+
101
+ - [vLLM](https://github.com/vllm-project/vllm)
102
+ - [LMStudio](https://lmstudio.ai/)
103
+ - Hugging Face Transformers and other major libraries.
104
+
105
+
106
+ ```python
107
+ from transformers import AutoTokenizer, AutoModelForCausalLM
108
+
109
+ model_name = "ZeroXClem/L3-Aspire-Heart-Matrix-8B"
110
+ tokenizer = AutoTokenizer.from_pretrained(model_name)
111
+ model = AutoModelForCausalLM.from_pretrained(model_name)
112
+
113
+ input_text = "What are the fundamentals of python programming?"
114
+ input_ids = tokenizer.encode(input_text, return_tensors="pt")
115
+ output = model.generate(input_ids, max_length=100)
116
+ response = tokenizer.decode(output[0], skip_special_tokens=True)
117
+ print(response)
118
+ ```
119
+
120
+ Whether you're fine-tuning for specific tasks or using it out of the box, this model is a good base for your applications.
121
+
122
+ *Please give us any feedback if issues arise during inference via the discussions tab.*
123
+
124
+ ---
125
+
126
+ ## βš–οΈ Ethical Considerations
127
+
128
+ Given its uncensored origins and the potential for emergent behaviors, users should exercise caution. Be mindful of:
129
+
130
+ - Potential biases in outputs.
131
+ - Unexpected or unpredictable behavior in uncensored settings.
132
+
133
+ **Best Practices:** Implement robust content filtering and ensure responsible deployment in production environments.
134
+
135
+ ---
136
+
137
+ ## πŸ™ Acknowledgements
138
+
139
+ A heartfelt thank-you to the creators of the original models:
140
+
141
+ - **DreadPoor** for [Aspire](https://huggingface.co/DreadPoor/Aspire-8B-model_stock) and [Heart Stolen](https://huggingface.co/DreadPoor/Heart_Stolen-8B-Model_Stock).
142
+ - **Khetterman** for [CursedMatrix](https://huggingface.co/Khetterman/CursedMatrix-8B-v9).
143
+
144
+ Your brilliant contributions made this merge a reality.
145
+
146
+ ---
147
+
148
+ ## πŸ“œ License
149
+
150
+ This model inherits the licensing terms of its base components. Please refer to the licenses of:
151
+
152
+ - [Aspire](https://huggingface.co/DreadPoor/Aspire-8B-model_stock)
153
+ - [Heart Stolen](https://huggingface.co/DreadPoor/Heart_Stolen-8B-Model_Stock)
154
+ - [CursedMatrix](https://huggingface.co/Khetterman/CursedMatrix-8B-v9)
155
+
156
+ Ensure compliance with all licensing requirements when using this model.
157
+
158
+ ---