Akshaykumarbm commited on
Commit
b70d627
·
verified ·
1 Parent(s): d989e47

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +124 -126
README.md CHANGED
@@ -1,199 +1,197 @@
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
  library_name: transformers
3
+ tags:
4
+ - mistral-8b
5
+ - openassistant
6
+ - openassisted-english
7
+ - language-modeling
8
+ - text-generation
9
+ - conversational-ai
10
+ license: apache-2.0
11
+ language:
12
+ - en
13
+ base_model:
14
+ - mistralai/Mistral-7B-Instruct-v0.1
15
  ---
16
 
 
17
 
18
+ # Mistral-8B Instruction-Tuned on OpenAssisted-English
19
 
20
+ This model is a fine-tuned version of [Mistral-8B](https://huggingface.co/mistralai/Mistral-7B-v0.1) on the [OpenAssisted-English](https://huggingface.co/datasets/OpenAssistant/oasst1) dataset using Hugging Face's `transformers` library. The model is optimized for high-quality conversational and instruction-following tasks in English.
21
 
22
+ ---
23
 
24
  ## Model Details
25
 
26
  ### Model Description
27
 
28
+ This model is an instruction-tuned version of the Mistral-8B architecture, fine-tuned specifically to follow human instructions and engage in helpful, safe, and factual conversations. It leverages the OpenAssisted-English dataset, a cleaned and filtered subset from OpenAssistant's OASST1 dataset.
29
 
30
+ * **Developed by:** Akshay Kumar BM
31
+ * **Fine-tuned using:** Hugging Face Transformers
32
+ * **Dataset used:** OpenAssisted-English (from OpenAssistant)
33
+ * **Model type:** Decoder-only Transformer
34
+ * **Language(s):** English
35
+ * **License:** Apache 2.0
36
+ * **Finetuned from model:** mistralai/Mistral-7B-v0.1
37
 
38
+ ---
 
 
 
 
 
 
39
 
40
+ ## Model Sources
41
 
42
+ * **Base Model:** [mistralai/Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1)
43
+ * **Dataset:** [OpenAssisted-English](https://huggingface.co/datasets/OpenAssistant/oasst1)
44
+ * **Library:** Hugging Face Transformers
45
+ * **Frameworks:** PyTorch, Accelerate
46
 
47
+ ---
 
 
48
 
49
  ## Uses
50
 
 
 
51
  ### Direct Use
52
 
53
+ * Conversational AI
54
+ * Instruction-following agents
55
+ * Text completion and generation
56
+ * Chatbot backends
57
+ * Question answering
58
 
59
+ ### Downstream Use
60
 
61
+ * Fine-tuning for specific domains (e.g., legal, medical, education)
62
+ * Integration into multi-agent systems or RAG pipelines
63
+ * Prompt engineering and prototyping
64
 
65
  ### Out-of-Scope Use
66
 
67
+ * Use in high-risk environments (e.g., medical diagnosis, legal decision making) without human oversight.
68
+ * Generating misinformation, harmful, offensive, or biased content.
69
+ * Any use violating Hugging Face’s or Apache 2.0 licensing terms.
70
 
71
+ ---
72
 
73
  ## Bias, Risks, and Limitations
74
 
75
+ Despite being fine-tuned for alignment, the model may:
76
 
77
+ * Hallucinate facts.
78
+ * Reflect biases present in the OpenAssistant dataset.
79
+ * Respond unpredictably to adversarial or ambiguous prompts.
80
 
81
  ### Recommendations
82
 
83
+ * Always include a human-in-the-loop for sensitive applications.
84
+ * Evaluate in domain-specific scenarios before deployment.
85
+ * Apply additional safety filters for production use.
86
+
87
+ ---
88
+
89
+ ## How to Get Started
90
 
91
+ ```python
92
+ from transformers import AutoModelForCausalLM, AutoTokenizer
93
 
94
+ model_id = "Akshaykumarbm/OpenAssisted-English-Mistral-7b"
95
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
96
+ model = AutoModelForCausalLM.from_pretrained(model_id)
97
 
98
+ input_prompt = "Explain quantum computing in simple terms."
99
+ inputs = tokenizer(input_prompt, return_tensors="pt")
100
+ outputs = model.generate(**inputs, max_new_tokens=200)
101
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
102
+ ```
103
 
104
+ ---
105
 
106
  ## Training Details
107
 
108
  ### Training Data
109
 
110
+ The model was trained on the **OpenAssisted-English** dataset, which includes high-quality, human-annotated instruction-response pairs derived from OpenAssistant’s OASST1 dataset.
111
 
112
+ * Format: Instruction + Response
113
+ * Filters: Language = English, Quality ≥ 3, Assistant messages only
114
+ * Size: \~100k samples
115
 
116
  ### Training Procedure
117
 
118
+ #### Preprocessing
 
 
119
 
120
+ * Tokenization: BPE tokenizer from Mistral
121
+ * Truncation: 4096 tokens
122
+ * Format: `<s>[INST] prompt [/INST] response</s>`
123
 
124
+ #### Hyperparameters
125
 
126
+ * **Precision:** bf16 mixed precision
127
+ * **Batch size:** 512 (global)
128
+ * **Epochs:** 15
129
+ * **Optimizer:** AdamW
130
+ * **LR Scheduler:** CosineDecay
131
+ * **Learning rate:** 2e-5
132
+ * **Warmup steps:** 500
133
 
134
+ #### Compute
135
 
136
+ * **Hardware:** AMD MI300
137
+ * **Training time:** \~18 hours
138
+ * **Frameworks:** PyTorch + Accelerate + DDP
139
 
140
+ ---
 
 
141
 
142
  ## Evaluation
143
 
144
+ ### Testing Data
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
145
 
146
+ * Held-out subset from OpenAssisted-English
147
+ * Manual eval for coherence, helpfulness, and safety
148
+ * Evaluation on MT-Bench and AlpacaEval (optional)
149
 
150
+ ### Metrics
151
 
152
+ * **Helpfulness Score** (manual): \~7.2/10
153
+ * **Toxicity (Perspective API):** <1%
154
+ * **BLEU, ROUGE:** Used to compare with gold responses
155
 
156
 
157
+ ---
158
 
159
+ ## Technical Specifications
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
160
 
161
+ * **Architecture:** Mistral 8B (decoder-only transformer)
162
+ * **Tokenizer:** Mistral Tokenizer (32k vocab)
163
+ * **Context Length:** 8k tokens
164
+ * **Parameters:** \~8.1 billion
165
 
166
+ ---
167
 
168
+ ## Citation
169
 
170
+ If you use this model, please cite the original Mistral model and OpenAssistant dataset.
171
 
172
+ ```bibtex
173
+ @misc{mistral2023,
174
+ title={Mistral 7B},
175
+ author={Mistral AI},
176
+ year={2023},
177
+ url={https://mistral.ai/news/announcing-mistral-7b/}
178
+ }
179
 
180
+ @misc{openassistant2023,
181
+ title = {OpenAssistant Conversations - OASST1},
182
+ author = {OpenAssistant Contributors},
183
+ year = {2023},
184
+ url = {https://huggingface.co/datasets/OpenAssistant/oasst1}
185
+ }
186
+ ```
187
 
188
+ ---
189
 
190
+ ## Contact
191
 
192
+ * **Author:** Akshay Kumar BM
193
+ * **Email:** [akshaykumarbedre.bm@gmail.com](mailto:akshaykumarbedre.bm@gmail.com)
194
+ * **GitHub:** [akshaykumarbedre](https://github.com/akshaykumarbedre)
195
+ * **Hugging Face:** [akshaykumarbm](https://huggingface.co/akshaykumarbm)
196
 
197
+ ---