Thermostatic commited on
Commit
9215ab6
1 Parent(s): 02fafba

Update README.md

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