Commit
·
4553c18
1
Parent(s):
ad091d5
Update README.md
Browse files
README.md
CHANGED
@@ -44,7 +44,7 @@ The entities detected by this model are:
|
|
44 |
- **License:** MIT
|
45 |
- **Finetuned from model:** roberta-base
|
46 |
|
47 |
-
### Model Sources
|
48 |
|
49 |
<!-- Provide the basic links for the model. -->
|
50 |
|
@@ -68,13 +68,7 @@ This approach could be adapted to other domains by using the training and develo
|
|
68 |
|
69 |
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
70 |
|
71 |
-
|
72 |
-
|
73 |
-
### Recommendations
|
74 |
-
|
75 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
76 |
-
|
77 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
78 |
|
79 |
## How to Get Started with the Model
|
80 |
|
@@ -142,20 +136,7 @@ A 70/15/15 train/val/test split was used which had the following breakdown of wo
|
|
142 |
|
143 |
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
144 |
|
145 |
-
|
146 |
-
|
147 |
-
[More Information Needed]
|
148 |
-
|
149 |
-
|
150 |
-
#### Training Hyperparameters
|
151 |
-
|
152 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
153 |
-
|
154 |
-
#### Speeds, Sizes, Times [optional]
|
155 |
-
|
156 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
157 |
-
|
158 |
-
[More Information Needed]
|
159 |
|
160 |
## Evaluation
|
161 |
|
@@ -175,82 +156,7 @@ A 70/15/15 train/val/test split was used which had the following breakdown of wo
|
|
175 |
|
176 |
[More Information Needed]
|
177 |
|
178 |
-
|
179 |
-
|
180 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
181 |
-
|
182 |
-
[More Information Needed]
|
183 |
-
|
184 |
-
### Results
|
185 |
-
|
186 |
-
[More Information Needed]
|
187 |
-
|
188 |
-
#### Summary
|
189 |
-
|
190 |
-
|
191 |
-
|
192 |
-
## Model Examination [optional]
|
193 |
-
|
194 |
-
<!-- Relevant interpretability work for the model goes here -->
|
195 |
-
|
196 |
-
[More Information Needed]
|
197 |
-
|
198 |
-
## Environmental Impact
|
199 |
-
|
200 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
201 |
-
|
202 |
-
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).
|
203 |
-
|
204 |
-
- **Hardware Type:** [More Information Needed]
|
205 |
-
- **Hours used:** [More Information Needed]
|
206 |
-
- **Cloud Provider:** [More Information Needed]
|
207 |
-
- **Compute Region:** [More Information Needed]
|
208 |
-
- **Carbon Emitted:** [More Information Needed]
|
209 |
-
|
210 |
-
## Technical Specifications [optional]
|
211 |
-
|
212 |
-
### Model Architecture and Objective
|
213 |
-
|
214 |
-
[More Information Needed]
|
215 |
-
|
216 |
-
### Compute Infrastructure
|
217 |
-
|
218 |
-
[More Information Needed]
|
219 |
-
|
220 |
-
#### Hardware
|
221 |
-
|
222 |
-
[More Information Needed]
|
223 |
-
|
224 |
-
#### Software
|
225 |
-
|
226 |
-
[More Information Needed]
|
227 |
-
|
228 |
-
## Citation [optional]
|
229 |
-
|
230 |
-
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
|
231 |
-
|
232 |
-
**BibTeX:**
|
233 |
-
|
234 |
-
[More Information Needed]
|
235 |
-
|
236 |
-
**APA:**
|
237 |
-
|
238 |
-
[More Information Needed]
|
239 |
-
|
240 |
-
## Glossary [optional]
|
241 |
-
|
242 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
243 |
-
|
244 |
-
[More Information Needed]
|
245 |
-
|
246 |
-
## More Information [optional]
|
247 |
-
|
248 |
-
[More Information Needed]
|
249 |
-
|
250 |
-
## Model Card Authors [optional]
|
251 |
-
|
252 |
-
[More Information Needed]
|
253 |
|
254 |
-
|
255 |
|
256 |
-
[More Information Needed]
|
|
|
44 |
- **License:** MIT
|
45 |
- **Finetuned from model:** roberta-base
|
46 |
|
47 |
+
### Model Sources
|
48 |
|
49 |
<!-- Provide the basic links for the model. -->
|
50 |
|
|
|
68 |
|
69 |
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
70 |
|
71 |
+
This model was trained entirely on English research articles and will likely not perform well on research in other languages. Also, the articles used to train the model were chosen based on being already present in the Neotoma database and therefore may have selection bias as they represent what is already known to be relevant to Neotoma and may not correctly manage new, previously missed articles.
|
|
|
|
|
|
|
|
|
|
|
|
|
72 |
|
73 |
## How to Get Started with the Model
|
74 |
|
|
|
136 |
|
137 |
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
138 |
|
139 |
+
For full training details please see the GitHub repository and Wiki: [github.com/NeotomaDB/MetaExtractor](https://github.com/NeotomaDB/MetaExtractor)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
140 |
|
141 |
## Evaluation
|
142 |
|
|
|
156 |
|
157 |
[More Information Needed]
|
158 |
|
159 |
+
## Results & Metrics
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
160 |
|
161 |
+
For full model results see the report here: [Final Project Report](https://github.com/NeotomaDB/MetaExtractor/blob/main/reports/final/finding-fossils-final.pdf)
|
162 |
|
|