Locutusque commited on
Commit
7c0a04b
1 Parent(s): e1163d7

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +68 -197
README.md CHANGED
@@ -2,200 +2,71 @@
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
- Preview version.
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]
200
-
201
-
 
2
  library_name: transformers
3
  tags: []
4
  ---
5
+ # Model Card: Hercules-3.0-Mistral-7B
6
+
7
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/6437292ecd93f4c9a34b0d47/Ip9wEG2Ne4vihNStHSDvX.png)
8
+
9
+ ## Model Description
10
+
11
+ Hercules-3.0-Mistral-7B is a fine-tuned language model derived from Mistralai/Mistral-7B-v0.1. It is specifically designed to excel in instruction following, function calls, and conversational interactions across various scientific and technical domains. The dataset used for fine-tuning, also named Hercules-v2.5, expands upon the diverse capabilities of OpenHermes-2.5 with contributions from numerous curated datasets. This fine-tuning has hercules-v2.5 with enhanced abilities in:
12
+
13
+ - Complex Instruction Following: Understanding and accurately executing multi-step instructions, even those involving specialized terminology.
14
+ - Function Calling: Seamlessly interpreting and executing function calls, providing appropriate input and output values.
15
+ - Domain-Specific Knowledge: Engaging in informative and educational conversations about Biology, Chemistry, Physics, Mathematics, Medicine, Computer Science, and more.
16
+
17
+ ## Intended Uses & Potential Bias
18
+
19
+ Hercules-3.0-Mistral-7B is well-suited to the following applications:
20
+
21
+ - Specialized Chatbots: Creating knowledgeable chatbots and conversational agents in scientific and technical fields.
22
+ - Instructional Assistants: Supporting users with educational and step-by-step guidance in various disciplines.
23
+ - Code Generation and Execution: Facilitating code execution through function calls, aiding in software development and prototyping.
24
+
25
+ **Important Note: Although Hercules-v3.0 is carefully constructed, it's important to be aware that the underlying data sources may contain biases or reflect harmful stereotypes. Use this model with caution and consider additional measures to mitigate potential biases in its responses.**
26
+
27
+ ## Limitations and Risks
28
+
29
+ - Toxicity: The dataset contains toxic or harmful examples.
30
+ - Hallucinations and Factual Errors: Like other language models, Hercules-3.0-Mistral-7B may generate incorrect or misleading information, especially in specialized domains where it lacks sufficient expertise.
31
+ - Potential for Misuse: The ability to engage in technical conversations and execute function calls could be misused for malicious purposes.
32
+
33
+ ## Training Data
34
+
35
+ Hercules-3.0-Mistral-7B is fine-tuned from the following sources:
36
+
37
+ - `cognitivecomputations/dolphin`
38
+ - `Evol Instruct 70K & 140K`
39
+ - `teknium/GPT4-LLM-Cleaned`
40
+ - `jondurbin/airoboros-3.2`
41
+ - `AlekseyKorshuk/camel-chatml`
42
+ - `CollectiveCognition/chats-data-2023-09-22`
43
+ - `Nebulous/lmsys-chat-1m-smortmodelsonly`
44
+ - `glaiveai/glaive-code-assistant-v2`
45
+ - `glaiveai/glaive-code-assistant`
46
+ - `glaiveai/glaive-function-calling-v2`
47
+ - `garage-bAInd/Open-Platypus`
48
+ - `meta-math/MetaMathQA`
49
+ - `teknium/GPTeacher-General-Instruct`
50
+ - `GPTeacher roleplay datasets`
51
+ - `BI55/MedText`
52
+ - `pubmed_qa labeled subset`
53
+ - `Unnatural Instructions`
54
+ - `M4-ai/LDJnr_combined_inout_format`
55
+ - `CollectiveCognition/chats-data-2023-09-27`
56
+ - `CollectiveCognition/chats-data-2023-10-16`
57
+ - `NobodyExistsOnTheInternet/sharegptPIPPA`
58
+ - `yuekai/openchat_sharegpt_v3_vicuna_format`
59
+ - `ise-uiuc/Magicoder-Evol-Instruct-110K`
60
+ - `Squish42/bluemoon-fandom-1-1-rp-cleaned`
61
+ - `sablo/oasst2_curated`
62
+
63
+ ## Training Procedure
64
+
65
+ - This model was trained on 8 kaggle TPUs, using torch xla SPMD for high MXU efficiency. There was no expense on my end (meaning you can reproduce this too!)
66
+ - A learning rate of 2e-06 with the Adam optimizer. A linear scheduler was used, with an end factor of 0.3. A low learning rate was used to prevent exploding gradients.
67
+ - No mixed precision was used, with the default dtype being bfloat16.
68
+ - Trained on 1,400,000 examples of Hercules-v3.0
69
+ - No model parameters were frozen.
70
+ - This model was trained on OpenAI's ChatML prompt format. Because this model has function calling capabilities, the prompt format is slightly different, here's what it would look like: ```<|im_start|>system\n{message}<|im_end|>\n<|im_start|>user\n{user message}<|im_end|>\n<|im_start|>call\n{function call message}<|im_end|>\n<|im_start|>function\n{function response message}<|im_end|>\n<|im_start|>assistant\n{assistant message}</s>```
71
+
72
+ This model was fine-tuned using the TPU-Alignment repository. https://github.com/Locutusque/TPU-Alignment