MLap commited on
Commit
fed3169
·
verified ·
1 Parent(s): e9621a9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +22 -21
README.md CHANGED
@@ -17,18 +17,19 @@ tags: []
17
 
18
  This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
 
20
- - **Developed by:** [Meta]
21
- - <!--
22
  - **Funded by [optional]:** [More Information Needed]
23
  - **Shared by [optional]:** [More Information Needed]
24
  - **Model type:** [More Information Needed]
25
  - **Language(s) (NLP):** [More Information Needed]
26
  - **License:** [More Information Needed]
27
  - **Finetuned from model [optional]:** [More Information Needed]
 
28
 
29
  ### Model Sources [optional]
30
 
31
- <!-- Provide the basic links for the model. -->
32
 
33
  - **Repository:** [More Information Needed]
34
  - **Paper [optional]:** [More Information Needed]
@@ -36,35 +37,35 @@ This is the model card of a 🤗 transformers model that has been pushed on the
36
 
37
  ## Uses
38
 
39
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
40
 
41
  ### Direct Use
42
 
43
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
44
 
45
  [More Information Needed]
46
 
47
  ### Downstream Use [optional]
48
 
49
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
50
 
51
  [More Information Needed]
52
 
53
  ### Out-of-Scope Use
54
 
55
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
56
 
57
  [More Information Needed]
58
 
59
  ## Bias, Risks, and Limitations
60
 
61
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
62
 
63
  [More Information Needed]
64
 
65
  ### Recommendations
66
 
67
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
68
 
69
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
70
 
@@ -78,13 +79,13 @@ Use the code below to get started with the model.
78
 
79
  ### Training Data
80
 
81
- <!-- 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. -->
82
 
83
  [More Information Needed]
84
 
85
  ### Training Procedure
86
 
87
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
88
 
89
  #### Preprocessing [optional]
90
 
@@ -93,35 +94,35 @@ Use the code below to get started with the model.
93
 
94
  #### Training Hyperparameters
95
 
96
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
97
 
98
  #### Speeds, Sizes, Times [optional]
99
 
100
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
101
 
102
  [More Information Needed]
103
 
104
  ## Evaluation
105
 
106
- <!-- This section describes the evaluation protocols and provides the results. -->
107
 
108
  ### Testing Data, Factors & Metrics
109
 
110
  #### Testing Data
111
 
112
- <!-- This should link to a Dataset Card if possible. -->
113
 
114
  [More Information Needed]
115
 
116
  #### Factors
117
 
118
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
119
 
120
  [More Information Needed]
121
 
122
  #### Metrics
123
 
124
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
125
 
126
  [More Information Needed]
127
 
@@ -135,13 +136,13 @@ Use the code below to get started with the model.
135
 
136
  ## Model Examination [optional]
137
 
138
- <!-- Relevant interpretability work for the model goes here -->
139
 
140
  [More Information Needed]
141
 
142
  ## Environmental Impact
143
 
144
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
145
 
146
  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).
147
 
@@ -171,7 +172,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
171
 
172
  ## Citation [optional]
173
 
174
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
175
 
176
  **BibTeX:**
177
 
@@ -183,7 +184,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
183
 
184
  ## Glossary [optional]
185
 
186
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
187
 
188
  [More Information Needed]
189
 
 
17
 
18
  This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
 
20
+ - **Developed by:**[Meta
21
+ <!--
22
  - **Funded by [optional]:** [More Information Needed]
23
  - **Shared by [optional]:** [More Information Needed]
24
  - **Model type:** [More Information Needed]
25
  - **Language(s) (NLP):** [More Information Needed]
26
  - **License:** [More Information Needed]
27
  - **Finetuned from model [optional]:** [More Information Needed]
28
+
29
 
30
  ### Model Sources [optional]
31
 
32
+ <!-- Provide the basic links for the model.
33
 
34
  - **Repository:** [More Information Needed]
35
  - **Paper [optional]:** [More Information Needed]
 
37
 
38
  ## Uses
39
 
40
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model.
41
 
42
  ### Direct Use
43
 
44
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app.
45
 
46
  [More Information Needed]
47
 
48
  ### Downstream Use [optional]
49
 
50
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app
51
 
52
  [More Information Needed]
53
 
54
  ### Out-of-Scope Use
55
 
56
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for.
57
 
58
  [More Information Needed]
59
 
60
  ## Bias, Risks, and Limitations
61
 
62
+ <!-- This section is meant to convey both technical and sociotechnical limitations.
63
 
64
  [More Information Needed]
65
 
66
  ### Recommendations
67
 
68
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations.
69
 
70
  Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
71
 
 
79
 
80
  ### Training Data
81
 
82
+ <!-- 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.
83
 
84
  [More Information Needed]
85
 
86
  ### Training Procedure
87
 
88
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure.
89
 
90
  #### Preprocessing [optional]
91
 
 
94
 
95
  #### Training Hyperparameters
96
 
97
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision
98
 
99
  #### Speeds, Sizes, Times [optional]
100
 
101
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc.
102
 
103
  [More Information Needed]
104
 
105
  ## Evaluation
106
 
107
+ <!-- This section describes the evaluation protocols and provides the results.
108
 
109
  ### Testing Data, Factors & Metrics
110
 
111
  #### Testing Data
112
 
113
+ <!-- This should link to a Dataset Card if possible.
114
 
115
  [More Information Needed]
116
 
117
  #### Factors
118
 
119
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains.
120
 
121
  [More Information Needed]
122
 
123
  #### Metrics
124
 
125
+ <!-- These are the evaluation metrics being used, ideally with a description of why.
126
 
127
  [More Information Needed]
128
 
 
136
 
137
  ## Model Examination [optional]
138
 
139
+ <!-- Relevant interpretability work for the model goes here
140
 
141
  [More Information Needed]
142
 
143
  ## Environmental Impact
144
 
145
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly
146
 
147
  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).
148
 
 
172
 
173
  ## Citation [optional]
174
 
175
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section.
176
 
177
  **BibTeX:**
178
 
 
184
 
185
  ## Glossary [optional]
186
 
187
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card.
188
 
189
  [More Information Needed]
190