flozi00 commited on
Commit
7015116
1 Parent(s): ab4c0ac

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +68 -170
README.md CHANGED
@@ -1,199 +1,97 @@
1
  ---
2
- library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
 
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
 
 
10
 
 
 
 
11
 
12
- ## Model Details
13
-
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
 
56
- [More Information Needed]
57
 
58
- ## Bias, Risks, and Limitations
 
 
59
 
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
 
84
- ### Training Procedure
85
 
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
 
88
- #### Preprocessing [optional]
89
 
90
- [More Information Needed]
 
 
91
 
 
92
 
93
- #### Training Hyperparameters
 
 
94
 
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
 
97
- #### Speeds, Sizes, Times [optional]
98
 
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
 
101
- [More Information Needed]
102
 
103
  ## Evaluation
104
 
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
 
189
- ## More Information [optional]
 
190
 
191
- [More Information Needed]
 
192
 
193
- ## Model Card Authors [optional]
 
194
 
195
- [More Information Needed]
196
 
197
- ## Model Card Contact
 
 
 
 
 
 
 
198
 
199
- [More Information Needed]
 
 
1
  ---
2
+ license: llama3.1
3
+ language:
4
+ - de
5
+ - en
6
+ - it
7
+ - fr
8
+ - pt
9
+ - es
10
+ tags:
11
+ - spectrum
12
  ---
13
 
14
+ ![Llama-3.1-SauerkrautLM-8b-Instruct]( https://vago-solutions.ai/wp-content/uploads/2024/07/Llama3.1-SauerkrautLM.png "Llama-3.1-SauerkrautLM-8b-Instruct")
15
+ ## VAGO solutions Llama-3.1-SauerkrautLM-8b-Instruct quantized by [Florian Zimmermeister](https://huggingface.co/flozi00) for fp8 usage
16
 
17
+ **Fine-tuned Model** - *to showcase the potential of resource-efficient Fine-Tuning of Large Language Models using **Spectrum Fine-Tuning***
18
 
19
+ Introducing **Llama-3.1-SauerkrautLM-8b-Instruct** – our Sauerkraut version of the powerful [meta-llama/Meta-Llama-3.1-8B-Instruct](https://huggingface.co/meta-llama/Meta-Llama-3.1-8B-Instruct)!
20
 
21
+ - Fine-tuning on German-English data with [**Spectrum**](https://github.com/cognitivecomputations/spectrum) Fine-Tuning **targeting 25% of the layers.**
22
+ - Utilized unique German-English Sauerkraut Mix v2
23
+ - Implemented bespoke, precision-engineered fine-tuning approach
24
 
25
+ # Table of Contents
26
+ 1. [Overview of all Llama-3.1-SauerkrautLM-8b-Instruct](#all-Llama-3.1-SauerkrautLM-8b-Instruct)
27
+ 2. [Model Details](#model-details)
28
+ - [Training procedure](#training-procedure)
29
+ 3. [Evaluation](#evaluation)
30
+ 5. [Disclaimer](#disclaimer)
31
+ 6. [Contact](#contact)
32
+ 7. [Collaborations](#collaborations)
33
+ 8. [Acknowledgement](#acknowledgement)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
34
 
35
+ ## All Llama-3.1-SauerkrautLM-8b-Instruct
36
 
37
+ | Model | HF | EXL2 | GGUF | AWQ |
38
+ |-------|-------|-------|-------|-------|
39
+ | Llama-3.1-SauerkrautLM-8b-Instruct | [Link](https://huggingface.co/VAGOsolutions/Llama-3.1-SauerkrautLM-8b-Instruct) | coming soon | coming soon | [Link](https://huggingface.co/VAGOsolutions/Llama-3.1-SauerkrautLM-8b-Instruct-awq) |
40
 
41
+ ## Model Details
42
+ **Llama-3.1-SauerkrautLM-8b-Instruct**
43
+ - **Model Type:** Llama-3.1-SauerkrautLM-8b-Instruct is a fine-tuned Model based on [meta-llama/Meta-Llama-3.1-8B-Instruct](https://huggingface.co/mistralai/meta-llama/Meta-Llama-3.1-8B-Instruct)
44
+ - **Language(s):** German, English
45
+ - **License:** llama3.1
46
+ - **Contact:** [VAGO solutions](https://vago-solutions.ai)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
47
 
48
+ ## Training Procedure
49
 
50
+ This model showcases the potential of resource-efficient fine-tuning of large language models using Spectrum Fine-Tuning. Here's a brief on the procedure:
51
 
52
+ **Fine-tuning on German-English Data**:
53
 
54
+ - Utilized Spectrum Fine-Tuning, targeting 25% of the model's layers
55
+ - Introduced the model to a unique German-English Sauerkraut Mix v2
56
+ - Implemented a bespoke, precision-engineered fine-tuning approach
57
 
58
+ **Sauerkraut Mix v2**:
59
 
60
+ - Premium Dataset for Language Models, focusing on German and English
61
+ - Meticulously selected, high-quality dataset combinations
62
+ - Cutting-edge synthetic datasets created using proprietary, high-precision generation techniques
63
 
64
+ ## Objective and Results
65
 
66
+ The primary goal of this training was to demonstrate that with Spectrum Fine-Tuning targeting 25% of the layers, a 8 billion parameter model can significantly enhance the capabilities while using a fraction of the resources of the classic fine-tuning approach.
67
 
68
+ The model has substantially improved skills in German and English, as demonstrated by impressive benchmarks on the new Hugging Face leaderboard.
69
 
70
+ **Spectrum Fine-Tuning can efficiently enhance a large language model's capabilities in multiple languages while preserving the majority of its previously acquired knowledge.**
71
 
72
  ## Evaluation
73
 
74
+ **AGIEVAL**
75
+ ![Llama-3.1-SauerkrautLM-8b-Instruct-AGIEVAL]( https://vago-solutions.ai/wp-content/uploads/2024/07/llama3.1-agieval1.png "Llama-3.1-SauerkrautLM-8b-Instruct-AGIEVAL")
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
76
 
77
+ **GPT4ALL**
78
+ ![Llama-3.1-SauerkrautLM-8b-Instruct-GPT4ALL]( https://vago-solutions.ai/wp-content/uploads/2024/07/llama3.1-GPT4ALL1.png "Llama-3.1-SauerkrautLM-8b-Instruct-GPT4ALL")
79
 
80
+ **TRUTHFULQA**
81
+ ![Llama-3.1-SauerkrautLM-8b-Instruct-TRUTHFULQA]( https://vago-solutions.ai/wp-content/uploads/2024/07/llama3.1-TQA1.png "Llama-3.1-SauerkrautLM-8b-Instruct-TRUTHFULQA")
82
 
83
+ **OPENLEADERBOARD 2**
84
+ ![Llama-3.1-SauerkrautLM-8b-Instruct-OPENLEADERBOARD]( https://vago-solutions.ai/wp-content/uploads/2024/07/llama3.1-HF21.png "Llama-3.1-SauerkrautLM-8b-Instruct-OPENLEADERBOARD")
85
 
 
86
 
87
+ ## Disclaimer
88
+ We must inform users that despite our best efforts in data cleansing, the possibility of uncensored content slipping through cannot be entirely ruled out. However, we cannot guarantee consistently appropriate behavior. Therefore, if you encounter any issues or come across inappropriate content, we kindly request that you inform us through the contact information provided. Additionally, it is essential to understand that the licensing of these models does not constitute legal advice. We are not held responsible for the actions of third parties who utilize our models.
89
+
90
+ ## Contact
91
+ If you are interested in customized LLMs for business applications, please get in contact with us via our website. We are also grateful for your feedback and suggestions.
92
+
93
+ ## Collaborations
94
+ We are also keenly seeking support and investment for our startup, VAGO solutions where we continuously advance the development of robust language models designed to address a diverse range of purposes and requirements. If the prospect of collaboratively navigating future challenges excites you, we warmly invite you to reach out to us at [VAGO solutions](https://vago-solutions.ai)
95
 
96
+ ## Acknowledgement
97
+ Many thanks to [meta-llama](https://huggingface.co/meta-llama) for providing such a valuable model to the Open-Source community.