Ezi commited on
Commit
bec3c81
β€’
1 Parent(s): a5c41a9

Update README.md

Browse files

Hi! πŸ‘‹
This PR has a preliminary model card, based on the format we are using as part of our effort to standardise model cards at Hugging Face. It is generated automatically using our [our tool](https://huggingface.co/spaces/huggingface/Model_Cards_Writing_Tool), as we’re testing our automatic Model Card generation abilities and running a study to see the effects of model cards on models.
Initial evidence suggests that model cards increase usage.
Please take a look when you get a chance, feel free to merge if you are ok with the changes or incorporate any additional informationπŸ€—

Files changed (1) hide show
  1. README.md +166 -4
README.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- language: "English"
3
  tags:
4
  - token-classification
5
  - NER
@@ -10,7 +10,169 @@ datasets:
10
  - BC4CHEMD
11
  license: apache-2.0
12
  ---
13
-
 
 
 
 
 
 
 
14
  BioBERT model fine-tuned in NER task with BC5CDR-chemicals and BC4CHEMD corpus.
15
-
16
- This was fine-tuned in order to use it in a BioNER/BioNEN system which is available at: https://github.com/librairy/bio-ner
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ language: en
3
  tags:
4
  - token-classification
5
  - NER
 
10
  - BC4CHEMD
11
  license: apache-2.0
12
  ---
13
+ ​
14
+ ​
15
+ # Model Card for biobert Chemical NER
16
+
17
+ # Model Details
18
+
19
+ ## Model Description
20
+
21
  BioBERT model fine-tuned in NER task with BC5CDR-chemicals and BC4CHEMD corpus.
22
+
23
+ - **Developed by:** librAIry
24
+ - **Shared by [Optional]:** Alvaro A
25
+ - **Model type:** Token Classification
26
+ - **Language(s) (NLP):** More information needed
27
+ - **License:** Apache 2.0
28
+ - **Parent Model:** NER
29
+ - **Resources for more information:**
30
+ - [GitHub Repo](https://github.com/librairy/bio-ner)
31
+ - [Associated Paper](https://oa.upm.es/67933/)
32
+
33
+ ​
34
+ ​
35
+ # Uses
36
+ ​
37
+ ## Direct Use
38
+ This model can be used for the task of model is lost/undocumented.
39
+ It was fine-tuned in order to use it in a BioNER/BioNEN system which is available at the [GitHub Repo](https://github.com/librairy/bio-ner)
40
+
41
+ ## Downstream Use [Optional]
42
+
43
+ More information needed.
44
+
45
+ ## Out-of-Scope Use
46
+
47
+ The model should not be used to intentionally create hostile or alienating environments for people.
48
+
49
+ # Bias, Risks, and Limitations
50
+
51
+
52
+ Significant research has explored bias and fairness issues with language models (see, e.g., [Sheng et al. (2021)](https://aclanthology.org/2021.acl-long.330.pdf) and [Bender et al. (2021)](https://dl.acm.org/doi/pdf/10.1145/3442188.3445922)). Predictions generated by the model may include disturbing and harmful stereotypes across protected classes; identity characteristics; and sensitive, social, and occupational groups.
53
+ ​
54
+ ​
55
+ ​
56
+ ## Recommendations
57
+
58
+
59
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
60
+ ​
61
+ # Training Details
62
+
63
+ ## Training Data
64
+
65
+ More information needed
66
+
67
+ ## Training Procedure
68
+ ​
69
+
70
+ ### Preprocessing
71
+
72
+ More information needed
73
+
74
+
75
+ ​
76
+ ​
77
+
78
+ ### Speeds, Sizes, Times
79
+ More information needed
80
+ ​
81
+
82
+ # Evaluation
83
+
84
+
85
+ ## Testing Data, Factors & Metrics
86
+
87
+ ### Testing Data
88
+
89
+ More information needed
90
+
91
+
92
+ ### Factors
93
+ More information needed
94
+
95
+ ### Metrics
96
+
97
+ More information needed
98
+
99
+
100
+ ## Results
101
+
102
+ More information needed
103
+ ​
104
+
105
+ # Model Examination
106
+
107
+ More information needed
108
+
109
+ # Environmental Impact
110
+
111
+ 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).
112
+
113
+ - **Hardware Type:** More information needed
114
+ - **Fine-tuning process**: was done in Google Collab using a TPU.
115
+ - **Hours used:** More information needed
116
+ - **Cloud Provider:** More information needed
117
+ - **Compute Region:** More information needed
118
+ - **Carbon Emitted:** More information needed
119
+
120
+ # Technical Specifications [optional]
121
+
122
+ ## Model Architecture and Objective
123
+ ​
124
+ More information needed
125
+
126
+ ## Compute Infrastructure
127
+
128
+ More information needed
129
+
130
+ ### Hardware
131
+
132
+
133
+ More information needed
134
+
135
+ ### Software
136
+
137
+ More information needed.
138
+
139
+ # Citation
140
+ ​
141
+
142
+ **BibTeX:**
143
+
144
+
145
+ More information needed.
146
+
147
+
148
+
149
+
150
+ # Glossary [optional]
151
+ More information needed
152
+
153
+ # More Information [optional]
154
+ More information needed
155
+ ​
156
+
157
+ # Model Card Authors [optional]
158
+
159
+ Alvaro A in collaboration with Ezi Ozoani and the Hugging Face team
160
+ ​
161
+ ​
162
+ # Model Card Contact
163
+
164
+ More information needed
165
+
166
+ # How to Get Started with the Model
167
+
168
+ Use the code below to get started with the model.
169
+
170
+ <details>
171
+ <summary> Click to expand </summary>
172
+ ​
173
+ ```python
174
+ from transformers import AutoTokenizer, AutoModelForTokenClassification
175
+ tokenizer = AutoTokenizer.from_pretrained("alvaroalon2/biobert_chemical_ner")
176
+ model = AutoModelForTokenClassification.from_pretrained("alvaroalon2/biobert_chemical_ner")
177
+ ```
178
+ </details>