Update README.md
Browse files
README.md
CHANGED
@@ -1,12 +1,23 @@
|
|
1 |
---
|
2 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
3 |
---
|
4 |
|
5 |
-
# Model Card for Model ID
|
6 |
|
7 |
<!-- Provide a quick summary of what the model is/does. -->
|
8 |
|
9 |
-
|
10 |
|
11 |
## Model Details
|
12 |
|
@@ -14,22 +25,22 @@ This modelcard aims to be a base template for new models. It has been generated
|
|
14 |
|
15 |
<!-- Provide a longer summary of what this model is. -->
|
16 |
|
|
|
17 |
|
18 |
-
|
19 |
-
- **
|
20 |
-
- **
|
21 |
-
- **
|
22 |
-
- **
|
23 |
-
- **
|
24 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
25 |
|
26 |
### Model Sources [optional]
|
27 |
|
28 |
<!-- Provide the basic links for the model. -->
|
29 |
|
30 |
-
- **Repository:** [More Information Needed]
|
31 |
-
- **Paper [optional]:** [More Information Needed]
|
32 |
-
- **Demo [optional]:** [More Information Needed]
|
33 |
|
34 |
## Uses
|
35 |
|
@@ -39,37 +50,37 @@ This modelcard aims to be a base template for new models. It has been generated
|
|
39 |
|
40 |
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
41 |
|
42 |
-
[More Information Needed]
|
43 |
|
44 |
### Downstream Use [optional]
|
45 |
|
46 |
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
47 |
|
48 |
-
[More Information Needed]
|
49 |
|
50 |
### Out-of-Scope Use
|
51 |
|
52 |
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
53 |
|
54 |
-
[More Information Needed]
|
55 |
|
56 |
## Bias, Risks, and Limitations
|
57 |
|
58 |
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
59 |
|
60 |
-
[More Information Needed]
|
61 |
|
62 |
### Recommendations
|
63 |
|
64 |
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
65 |
|
66 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
67 |
|
68 |
## How to Get Started with the Model
|
69 |
|
70 |
Use the code below to get started with the model.
|
71 |
|
72 |
-
[More Information Needed]
|
73 |
|
74 |
## Training Details
|
75 |
|
@@ -77,7 +88,7 @@ Use the code below to get started with the model.
|
|
77 |
|
78 |
<!-- This should link to a Data 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. -->
|
79 |
|
80 |
-
[More Information Needed]
|
81 |
|
82 |
### Training Procedure
|
83 |
|
@@ -85,18 +96,18 @@ Use the code below to get started with the model.
|
|
85 |
|
86 |
#### Preprocessing [optional]
|
87 |
|
88 |
-
[More Information Needed]
|
89 |
|
90 |
|
91 |
#### Training Hyperparameters
|
92 |
|
93 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
94 |
|
95 |
#### Speeds, Sizes, Times [optional]
|
96 |
|
97 |
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
98 |
|
99 |
-
[More Information Needed]
|
100 |
|
101 |
## Evaluation
|
102 |
|
@@ -108,33 +119,33 @@ Use the code below to get started with the model.
|
|
108 |
|
109 |
<!-- This should link to a Data Card if possible. -->
|
110 |
|
111 |
-
[More Information Needed]
|
112 |
|
113 |
#### Factors
|
114 |
|
115 |
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
116 |
|
117 |
-
[More Information Needed]
|
118 |
|
119 |
#### Metrics
|
120 |
|
121 |
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
122 |
|
123 |
-
[More Information Needed]
|
124 |
|
125 |
### Results
|
126 |
|
127 |
-
[More Information Needed]
|
128 |
|
129 |
#### Summary
|
130 |
|
131 |
-
|
132 |
|
133 |
## Model Examination [optional]
|
134 |
|
135 |
<!-- Relevant interpretability work for the model goes here -->
|
136 |
|
137 |
-
[More Information Needed]
|
138 |
|
139 |
## Environmental Impact
|
140 |
|
@@ -142,29 +153,29 @@ Use the code below to get started with the model.
|
|
142 |
|
143 |
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).
|
144 |
|
145 |
-
- **Hardware Type:** [More Information Needed]
|
146 |
-
- **Hours used:** [More Information Needed]
|
147 |
-
- **Cloud Provider:** [More Information Needed]
|
148 |
-
- **Compute Region:** [More Information Needed]
|
149 |
-
- **Carbon Emitted:** [More Information Needed]
|
150 |
|
151 |
## Technical Specifications [optional]
|
152 |
|
153 |
### Model Architecture and Objective
|
154 |
|
155 |
-
[More Information Needed]
|
156 |
|
157 |
### Compute Infrastructure
|
158 |
|
159 |
-
[More Information Needed]
|
160 |
|
161 |
#### Hardware
|
162 |
|
163 |
-
[More Information Needed]
|
164 |
|
165 |
#### Software
|
166 |
|
167 |
-
[More Information Needed]
|
168 |
|
169 |
## Citation [optional]
|
170 |
|
@@ -172,28 +183,26 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
|
|
172 |
|
173 |
**BibTeX:**
|
174 |
|
175 |
-
[More Information Needed]
|
176 |
|
177 |
**APA:**
|
178 |
|
179 |
-
[More Information Needed]
|
180 |
|
181 |
## Glossary [optional]
|
182 |
|
183 |
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
184 |
|
185 |
-
[More Information Needed]
|
186 |
|
187 |
## More Information [optional]
|
188 |
|
189 |
-
[More Information Needed]
|
190 |
|
191 |
## Model Card Authors [optional]
|
192 |
|
193 |
-
[More Information Needed]
|
194 |
|
195 |
## Model Card Contact
|
196 |
|
197 |
-
[More Information Needed]
|
198 |
-
|
199 |
-
|
|
|
1 |
---
|
2 |
+
'[object Object]': null
|
3 |
+
license: bigscience-openrail-m
|
4 |
+
datasets:
|
5 |
+
- tiiuae/falcon-refinedweb
|
6 |
+
language:
|
7 |
+
- ab
|
8 |
+
metrics:
|
9 |
+
- accuracy
|
10 |
+
library_name: allennlp
|
11 |
+
pipeline_tag: text-classification
|
12 |
+
tags:
|
13 |
+
- chemistry
|
14 |
---
|
15 |
|
16 |
+
# Model Card for {{ model_id | default("Model ID", true) }}
|
17 |
|
18 |
<!-- Provide a quick summary of what the model is/does. -->
|
19 |
|
20 |
+
{{ model_summary | default("", true) }}
|
21 |
|
22 |
## Model Details
|
23 |
|
|
|
25 |
|
26 |
<!-- Provide a longer summary of what this model is. -->
|
27 |
|
28 |
+
{{ model_description | default("", true) }}
|
29 |
|
30 |
+
- **Developed by:** {{ developers | default("[More Information Needed]", true)}}
|
31 |
+
- **Shared by [optional]:** {{ shared_by | default("[More Information Needed]", true)}}
|
32 |
+
- **Model type:** {{ model_type | default("[More Information Needed]", true)}}
|
33 |
+
- **Language(s) (NLP):** {{ language | default("[More Information Needed]", true)}}
|
34 |
+
- **License:** {{ license | default("[More Information Needed]", true)}}
|
35 |
+
- **Finetuned from model [optional]:** {{ finetuned_from | default("[More Information Needed]", true)}}
|
|
|
36 |
|
37 |
### Model Sources [optional]
|
38 |
|
39 |
<!-- Provide the basic links for the model. -->
|
40 |
|
41 |
+
- **Repository:** {{ repo | default("[More Information Needed]", true)}}
|
42 |
+
- **Paper [optional]:** {{ paper | default("[More Information Needed]", true)}}
|
43 |
+
- **Demo [optional]:** {{ demo | default("[More Information Needed]", true)}}
|
44 |
|
45 |
## Uses
|
46 |
|
|
|
50 |
|
51 |
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
52 |
|
53 |
+
{{ direct_use | default("[More Information Needed]", true)}}
|
54 |
|
55 |
### Downstream Use [optional]
|
56 |
|
57 |
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
58 |
|
59 |
+
{{ downstream_use | default("[More Information Needed]", true)}}
|
60 |
|
61 |
### Out-of-Scope Use
|
62 |
|
63 |
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
64 |
|
65 |
+
{{ out_of_scope_use | default("[More Information Needed]", true)}}
|
66 |
|
67 |
## Bias, Risks, and Limitations
|
68 |
|
69 |
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
70 |
|
71 |
+
{{ bias_risks_limitations | default("[More Information Needed]", true)}}
|
72 |
|
73 |
### Recommendations
|
74 |
|
75 |
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
76 |
|
77 |
+
{{ bias_recommendations | default("Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.", true)}}
|
78 |
|
79 |
## How to Get Started with the Model
|
80 |
|
81 |
Use the code below to get started with the model.
|
82 |
|
83 |
+
{{ get_started_code | default("[More Information Needed]", true)}}
|
84 |
|
85 |
## Training Details
|
86 |
|
|
|
88 |
|
89 |
<!-- This should link to a Data 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. -->
|
90 |
|
91 |
+
{{ training_data | default("[More Information Needed]", true)}}
|
92 |
|
93 |
### Training Procedure
|
94 |
|
|
|
96 |
|
97 |
#### Preprocessing [optional]
|
98 |
|
99 |
+
{{ preprocessing | default("[More Information Needed]", true)}}
|
100 |
|
101 |
|
102 |
#### Training Hyperparameters
|
103 |
|
104 |
+
- **Training regime:** {{ training_regime | default("[More Information Needed]", true)}} <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
105 |
|
106 |
#### Speeds, Sizes, Times [optional]
|
107 |
|
108 |
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
109 |
|
110 |
+
{{ speeds_sizes_times | default("[More Information Needed]", true)}}
|
111 |
|
112 |
## Evaluation
|
113 |
|
|
|
119 |
|
120 |
<!-- This should link to a Data Card if possible. -->
|
121 |
|
122 |
+
{{ testing_data | default("[More Information Needed]", true)}}
|
123 |
|
124 |
#### Factors
|
125 |
|
126 |
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
127 |
|
128 |
+
{{ testing_factors | default("[More Information Needed]", true)}}
|
129 |
|
130 |
#### Metrics
|
131 |
|
132 |
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
133 |
|
134 |
+
{{ testing_metrics | default("[More Information Needed]", true)}}
|
135 |
|
136 |
### Results
|
137 |
|
138 |
+
{{ results | default("[More Information Needed]", true)}}
|
139 |
|
140 |
#### Summary
|
141 |
|
142 |
+
{{ results_summary | default("", true) }}
|
143 |
|
144 |
## Model Examination [optional]
|
145 |
|
146 |
<!-- Relevant interpretability work for the model goes here -->
|
147 |
|
148 |
+
{{ model_examination | default("[More Information Needed]", true)}}
|
149 |
|
150 |
## Environmental Impact
|
151 |
|
|
|
153 |
|
154 |
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).
|
155 |
|
156 |
+
- **Hardware Type:** {{ hardware | default("[More Information Needed]", true)}}
|
157 |
+
- **Hours used:** {{ hours_used | default("[More Information Needed]", true)}}
|
158 |
+
- **Cloud Provider:** {{ cloud_provider | default("[More Information Needed]", true)}}
|
159 |
+
- **Compute Region:** {{ cloud_region | default("[More Information Needed]", true)}}
|
160 |
+
- **Carbon Emitted:** {{ co2_emitted | default("[More Information Needed]", true)}}
|
161 |
|
162 |
## Technical Specifications [optional]
|
163 |
|
164 |
### Model Architecture and Objective
|
165 |
|
166 |
+
{{ model_specs | default("[More Information Needed]", true)}}
|
167 |
|
168 |
### Compute Infrastructure
|
169 |
|
170 |
+
{{ compute_infrastructure | default("[More Information Needed]", true)}}
|
171 |
|
172 |
#### Hardware
|
173 |
|
174 |
+
{{ hardware | default("[More Information Needed]", true)}}
|
175 |
|
176 |
#### Software
|
177 |
|
178 |
+
{{ software | default("[More Information Needed]", true)}}
|
179 |
|
180 |
## Citation [optional]
|
181 |
|
|
|
183 |
|
184 |
**BibTeX:**
|
185 |
|
186 |
+
{{ citation_bibtex | default("[More Information Needed]", true)}}
|
187 |
|
188 |
**APA:**
|
189 |
|
190 |
+
{{ citation_apa | default("[More Information Needed]", true)}}
|
191 |
|
192 |
## Glossary [optional]
|
193 |
|
194 |
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
195 |
|
196 |
+
{{ glossary | default("[More Information Needed]", true)}}
|
197 |
|
198 |
## More Information [optional]
|
199 |
|
200 |
+
{{ more_information | default("[More Information Needed]", true)}}
|
201 |
|
202 |
## Model Card Authors [optional]
|
203 |
|
204 |
+
{{ model_card_authors | default("[More Information Needed]", true)}}
|
205 |
|
206 |
## Model Card Contact
|
207 |
|
208 |
+
{{ model_card_contact | default("[More Information Needed]", true)}}
|
|
|
|