Thermostatic commited on
Commit
b2b0ea7
·
verified ·
1 Parent(s): 4f9c6f7

Update README.md

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