Nhoseinnia commited on
Commit
65284f2
1 Parent(s): 4996373

Update README.md

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