Thermostatic commited on
Commit
c0f1ab0
1 Parent(s): 11e6288

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +214 -0
README.md CHANGED
@@ -1,3 +1,217 @@
1
  ---
2
  license: mit
 
 
 
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: mit
3
+ datasets:
4
+ - Thermostatic/ShareGPT_NeuralTranslate_v0.1
5
+ language:
6
+ - en
7
+ - es
8
+ tags:
9
+ - Translation
10
+ - Mistral
11
+ - English
12
+ - Spanish
13
  ---
14
+
15
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/64c8b32f36c11430f3149da8/VWFlg-T1WSCFsynhw8uzr.png)
16
+
17
+ # Model Card for NeuralTranslate
18
+
19
+ <!-- Provide a quick summary of what the model is/does. -->
20
+
21
+ THIS MODEL USES CHATML TEMPLATE!! BE CAREFUL OR YOU MIGHT FIND UNEXPECTED BEHAVIOURS.
22
+
23
+ This is the second alpha version of NeuralTranslate. This alpha version doesn't contain overfitting (or at least that's what I think), so no unexpected behaviour should happen and Mistral's native reasoning capabilities aren't lost.
24
+
25
+ NeuralTranslate is an open-source family of models for bidirectional translation between English & Spanish, achieving high accuracy at fast speed.
26
+
27
+ You can donate towards this project at my ko-fi! https://ko-fi.com/irvingernesto
28
+
29
+
30
+ ## Model Details
31
+
32
+ ### Model Description
33
+
34
+ <!-- Provide a longer summary of what this model is. -->
35
+
36
+
37
+
38
+ - **Developed by:** [More Information Needed]
39
+ - **Funded by [optional]:** [More Information Needed]
40
+ - **Shared by [optional]:** [More Information Needed]
41
+ - **Model type:** [More Information Needed]
42
+ - **Language(s) (NLP):** [More Information Needed]
43
+ - **License:** [More Information Needed]
44
+ - **Finetuned from model [optional]:** [More Information Needed]
45
+
46
+ ### Model Sources [optional]
47
+
48
+ <!-- Provide the basic links for the model. -->
49
+
50
+ - **Repository:** [More Information Needed]
51
+ - **Paper [optional]:** [More Information Needed]
52
+ - **Demo [optional]:** [More Information Needed]
53
+
54
+ ## Uses
55
+
56
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
57
+
58
+ ### Direct Use
59
+
60
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
61
+
62
+ [More Information Needed]
63
+
64
+ ### Downstream Use [optional]
65
+
66
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
67
+
68
+ [More Information Needed]
69
+
70
+ ### Out-of-Scope Use
71
+
72
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
73
+
74
+ [More Information Needed]
75
+
76
+ ## Bias, Risks, and Limitations
77
+
78
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
79
+
80
+ [More Information Needed]
81
+
82
+ ### Recommendations
83
+
84
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
85
+
86
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
87
+
88
+ ## How to Get Started with the Model
89
+
90
+ Use the code below to get started with the model.
91
+
92
+ [More Information Needed]
93
+
94
+ ## Training Details
95
+
96
+ ### Training Data
97
+
98
+ <!-- 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. -->
99
+
100
+ [More Information Needed]
101
+
102
+ ### Training Procedure
103
+
104
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
105
+
106
+ #### Preprocessing [optional]
107
+
108
+ [More Information Needed]
109
+
110
+
111
+ #### Training Hyperparameters
112
+
113
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
114
+
115
+ #### Speeds, Sizes, Times [optional]
116
+
117
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
118
+
119
+ [More Information Needed]
120
+
121
+ ## Evaluation
122
+
123
+ <!-- This section describes the evaluation protocols and provides the results. -->
124
+
125
+ ### Testing Data, Factors & Metrics
126
+
127
+ #### Testing Data
128
+
129
+ <!-- This should link to a Dataset Card if possible. -->
130
+
131
+ [More Information Needed]
132
+
133
+ #### Factors
134
+
135
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
136
+
137
+ [More Information Needed]
138
+
139
+ #### Metrics
140
+
141
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
142
+
143
+ [More Information Needed]
144
+
145
+ ### Results
146
+
147
+ [More Information Needed]
148
+
149
+ #### Summary
150
+
151
+
152
+
153
+ ## Model Examination [optional]
154
+
155
+ <!-- Relevant interpretability work for the model goes here -->
156
+
157
+ [More Information Needed]
158
+
159
+ ## Environmental Impact
160
+
161
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
162
+
163
+ 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).
164
+
165
+ - **Hardware Type:** [More Information Needed]
166
+ - **Hours used:** [More Information Needed]
167
+ - **Cloud Provider:** [More Information Needed]
168
+ - **Compute Region:** [More Information Needed]
169
+ - **Carbon Emitted:** [More Information Needed]
170
+
171
+ ## Technical Specifications [optional]
172
+
173
+ ### Model Architecture and Objective
174
+
175
+ [More Information Needed]
176
+
177
+ ### Compute Infrastructure
178
+
179
+ [More Information Needed]
180
+
181
+ #### Hardware
182
+
183
+ [More Information Needed]
184
+
185
+ #### Software
186
+
187
+ [More Information Needed]
188
+
189
+ ## Citation [optional]
190
+
191
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
192
+
193
+ **BibTeX:**
194
+
195
+ [More Information Needed]
196
+
197
+ **APA:**
198
+
199
+ [More Information Needed]
200
+
201
+ ## Glossary [optional]
202
+
203
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
204
+
205
+ [More Information Needed]
206
+
207
+ ## More Information [optional]
208
+
209
+ [More Information Needed]
210
+
211
+ ## Model Card Authors [optional]
212
+
213
+ [More Information Needed]
214
+
215
+ ## Model Card Contact
216
+
217
+ [More Information Needed]