Muthukumaran commited on
Commit
f01d42f
·
1 Parent(s): 73a331d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +38 -147
README.md CHANGED
@@ -12,193 +12,84 @@ tags:
12
 
13
  <!-- Provide a quick summary of what the model is/does. -->
14
 
15
- This domain-adapted (RoBERTa)[https://huggingface.co/roberta-base] based Encoder model is finetuned using select scientific journals and articles. It's intended purpose is to aid in NLP efforts within NASA. e.g.: Information retrieval, Intelligent search and discovery,
16
 
17
  ## Model Details
 
 
 
 
18
 
19
  ### Model Description
20
 
21
- <!-- Provide a longer summary of what this model is. -->
22
-
23
-
24
-
25
- - **Developed by:** NASA IMPACT and IBM Research
26
  - **Funded by [optional]:** [More Information Needed]
27
  - **Shared by [optional]:** [More Information Needed]
28
  - **Model type:** [More Information Needed]
29
  - **Language(s) (NLP):** [More Information Needed]
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
-
77
- Use the code below to get started with the model.
78
-
79
- [More Information Needed]
80
 
81
  ## Training Details
82
 
83
  ### Training Data
84
 
85
- <!-- 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. -->
86
-
87
- [More Information Needed]
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
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
 
 
101
 
102
- #### Speeds, Sizes, Times [optional]
103
 
104
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
 
 
 
105
 
106
- [More Information Needed]
 
 
107
 
108
  ## Evaluation
109
 
110
- <!-- This section describes the evaluation protocols and provides the results. -->
111
 
112
- ### Testing Data, Factors & Metrics
113
 
114
- #### Testing Data
115
 
116
- <!-- This should link to a Dataset Card if possible. -->
117
 
118
- [More Information Needed]
119
 
120
- #### Factors
121
 
122
  <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
123
 
124
- [More Information Needed]
125
-
126
- #### Metrics
127
-
128
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
129
-
130
- [More Information Needed]
131
-
132
- ### Results
133
-
134
- [More Information Needed]
135
-
136
- #### Summary
137
-
138
-
139
-
140
- ## Model Examination [optional]
141
-
142
- <!-- Relevant interpretability work for the model goes here -->
143
-
144
- [More Information Needed]
145
-
146
- ## Environmental Impact
147
-
148
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
149
-
150
- 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).
151
-
152
- - **Hardware Type:** [More Information Needed]
153
- - **Hours used:** [More Information Needed]
154
- - **Cloud Provider:** [More Information Needed]
155
- - **Compute Region:** [More Information Needed]
156
- - **Carbon Emitted:** [More Information Needed]
157
-
158
- ## Technical Specifications [optional]
159
-
160
- ### Model Architecture and Objective
161
-
162
- [More Information Needed]
163
-
164
- ### Compute Infrastructure
165
-
166
- [More Information Needed]
167
-
168
- #### Hardware
169
-
170
- [More Information Needed]
171
-
172
- #### Software
173
-
174
- [More Information Needed]
175
-
176
- ## Citation [optional]
177
-
178
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
179
-
180
- **BibTeX:**
181
-
182
- [More Information Needed]
183
-
184
- **APA:**
185
-
186
- [More Information Needed]
187
-
188
- ## Glossary [optional]
189
 
190
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
191
 
192
- [More Information Needed]
193
 
194
- ## More Information [optional]
195
 
196
- [More Information Needed]
197
 
198
  ## Model Card Authors [optional]
199
 
200
- [More Information Needed]
 
201
 
202
  ## Model Card Contact
203
 
204
- [More Information Needed]
 
12
 
13
  <!-- Provide a quick summary of what the model is/does. -->
14
 
15
+ This domain-adapted,(RoBERTa)[https://huggingface.co/roberta-base] based, Encoder-only transformer model is finetuned using select scientific journals and articles related to NASA Science Mission Directorate(SMD). It's intended purpose is to aid in NLP efforts within NASA. e.g.: Information retrieval, Intelligent search and discovery.
16
 
17
  ## Model Details
18
+ - RoBERTa as base model
19
+ - Custom tokenizer
20
+ - 125M parameters
21
+ - Masked Language Modeling (MLM) pretraining strategy
22
 
23
  ### Model Description
24
 
25
+ <!-- - **Developed by:** NASA IMPACT and IBM Research
 
 
 
 
26
  - **Funded by [optional]:** [More Information Needed]
27
  - **Shared by [optional]:** [More Information Needed]
28
  - **Model type:** [More Information Needed]
29
  - **Language(s) (NLP):** [More Information Needed]
30
  - **License:** [More Information Needed]
31
+ - **Finetuned from model [optional]:** [More Information Needed] -->
 
 
 
 
 
 
 
 
32
 
33
  ## Uses
34
 
35
+ - Named Entity Recognition (NER), Information revreival, sentence-transformers.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
 
37
  ## Training Details
38
 
39
  ### Training Data
40
 
41
+ The model was trained on the following datasets:
42
+ 1. Wikipedia English dump of February 1, 2020
43
+ 2. NASA own data
44
+ 3. NASA papers
45
+ 4. NASA Earth Science papers
46
+ 5. NASA Astrophysics Data System
47
+ 6. PubMed abstract
48
+ 7. PMC : subset with commercial license
 
 
 
 
 
 
49
 
50
+ The sizes of the dataset is shown in the following chart.
51
+
52
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/61099e5d86580d4580767226/CTNkn0WHS268hvidFmoqj.png)
53
 
54
+ <!-- Provide the basic links for the model.
55
 
56
+ - **Repository:** [More Information Needed]
57
+ - **Paper [optional]:** [More Information Needed]
58
+ - **Demo [optional]:** [More Information Needed]
59
+ -->
60
 
61
+ ### Training Procedure
62
+ The model was trained on fairseq 0.12.1 with PyTorch 1.9.1 on transformer version 4.2.0. Masked Language Modeling (MLM) is the pretraining stragegy used.
63
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
64
 
65
  ## Evaluation
66
 
67
+ ### BLURB Benchmark
68
 
69
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/61099e5d86580d4580767226/K0IpQnTQmrfQJ1JXxn1B6.png)
70
 
 
71
 
72
+ ### Pruned SQuAD2.0 (SQ2) Benchmark
73
 
 
74
 
75
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/61099e5d86580d4580767226/R4oMJquUz4puah3lvd5Ve.png)
76
 
77
  <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
78
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
79
 
80
+ ### NASA SMD Experts Benchmark
81
 
82
+ WIP!
83
 
84
+ ## Citation
85
 
86
+ Please use the DOI provided by Huggingface to cite the model.
87
 
88
  ## Model Card Authors [optional]
89
 
90
+ Bishwaranjan Bhattacharjee, IBM Research
91
+ Muthukumaran Ramasubramanian, NASA-IMPACT ([email protected])
92
 
93
  ## Model Card Contact
94
 
95
+ Muthukumaran Ramasubramanian ([email protected])