palomapiot commited on
Commit
8b69d5d
1 Parent(s): ed11ad5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -117
README.md CHANGED
@@ -11,18 +11,13 @@ tags:
11
  - hate speech
12
  ---
13
 
14
- # Model Card for Model ID
15
 
16
- <!-- Provide a quick summary of what the model is/does. -->
17
-
18
-
19
-
20
- ## Model Details
21
-
22
- ### Model Description
23
-
24
- <!-- Provide a longer summary of what this model is. -->
25
 
 
 
26
 
27
 
28
  - **Developed by:** [More Information Needed]
@@ -39,29 +34,7 @@ tags:
39
 
40
  - **Repository:** [More Information Needed]
41
  - **Paper [optional]:** [More Information Needed]
42
- - **Demo [optional]:** [More Information Needed]
43
 
44
- ## Uses
45
-
46
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
47
-
48
- ### Direct Use
49
-
50
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
51
-
52
- [More Information Needed]
53
-
54
- ### Downstream Use [optional]
55
-
56
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
57
-
58
- [More Information Needed]
59
-
60
- ### Out-of-Scope Use
61
-
62
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
63
-
64
- [More Information Needed]
65
 
66
  ## Bias, Risks, and Limitations
67
 
@@ -89,62 +62,15 @@ Use the code below to get started with the model.
89
 
90
  [More Information Needed]
91
 
92
- ### Training Procedure
93
-
94
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
95
-
96
- #### Preprocessing [optional]
97
-
98
- [More Information Needed]
99
-
100
 
101
  #### Training Hyperparameters
102
 
103
  - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
104
 
105
- #### Speeds, Sizes, Times [optional]
106
-
107
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
108
-
109
- [More Information Needed]
110
-
111
- ## Evaluation
112
-
113
- <!-- This section describes the evaluation protocols and provides the results. -->
114
-
115
- ### Testing Data, Factors & Metrics
116
-
117
- #### Testing Data
118
-
119
- <!-- This should link to a Dataset Card if possible. -->
120
-
121
- [More Information Needed]
122
-
123
- #### Factors
124
-
125
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
126
-
127
- [More Information Needed]
128
-
129
- #### Metrics
130
-
131
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
132
-
133
- [More Information Needed]
134
-
135
- ### Results
136
-
137
- [More Information Needed]
138
-
139
- #### Summary
140
-
141
-
142
-
143
- ## Model Examination [optional]
144
-
145
- <!-- Relevant interpretability work for the model goes here -->
146
-
147
- [More Information Needed]
148
 
149
  ## Environmental Impact
150
 
@@ -158,23 +84,6 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
158
  - **Compute Region:** [More Information Needed]
159
  - **Carbon Emitted:** [More Information Needed]
160
 
161
- ## Technical Specifications [optional]
162
-
163
- ### Model Architecture and Objective
164
-
165
- [More Information Needed]
166
-
167
- ### Compute Infrastructure
168
-
169
- [More Information Needed]
170
-
171
- #### Hardware
172
-
173
- [More Information Needed]
174
-
175
- #### Software
176
-
177
- [More Information Needed]
178
 
179
  ## Citation [optional]
180
 
@@ -188,23 +97,6 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
188
 
189
  [More Information Needed]
190
 
191
- ## Glossary [optional]
192
-
193
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
194
-
195
- [More Information Needed]
196
-
197
- ## More Information [optional]
198
-
199
- [More Information Needed]
200
-
201
- ## Model Card Authors [optional]
202
-
203
- [More Information Needed]
204
-
205
- ## Model Card Contact
206
-
207
- [More Information Needed]
208
  ## Training procedure
209
 
210
 
 
11
  - hate speech
12
  ---
13
 
14
+ # Mistral Fine-Tuned on not Engaging with Hate Speech
15
 
16
+ ## Model Description
17
+ This model is a fine-tuned version of `mistralai/Mistral-7B-Instruct-v0.2` on a hate speech dataset using the PEFT approach, to prevent the model from exacerbating hate discourse.
 
 
 
 
 
 
 
18
 
19
+ ## Intended Uses & Limitations
20
+ This model is intended for research purposes in conversational applications to stop hate speech generation.
21
 
22
 
23
  - **Developed by:** [More Information Needed]
 
34
 
35
  - **Repository:** [More Information Needed]
36
  - **Paper [optional]:** [More Information Needed]
 
37
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
38
 
39
  ## Bias, Risks, and Limitations
40
 
 
62
 
63
  [More Information Needed]
64
 
65
+ ## Training Procedure
66
+ - **Base Model:** mistralai/Mistral-7B-Instruct-v0.1
67
+ - **Fine-Tuning:** Using PEFT approach
68
+ - **Hardware:** Information about the hardware used
 
 
 
 
69
 
70
  #### Training Hyperparameters
71
 
72
  - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
73
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
74
 
75
  ## Environmental Impact
76
 
 
84
  - **Compute Region:** [More Information Needed]
85
  - **Carbon Emitted:** [More Information Needed]
86
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
87
 
88
  ## Citation [optional]
89
 
 
97
 
98
  [More Information Needed]
99
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
100
  ## Training procedure
101
 
102