pranav-s commited on
Commit
4f7bb8b
1 Parent(s): f1b9184

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +4 -4
README.md CHANGED
@@ -9,16 +9,16 @@ license: other
9
 
10
  # PolymerNER
11
 
12
- This model is a fine-tuned version of the MaterialsBERT model on a dataset of 638 abstracts and contains a linear layer on top of MaterialsBERT to predict the entity type of each token. The entity types predicted by this model are POLYMER, POLYMER\_FAMILY, ORGANIC, INORGANIC, MONOMER, PROP\_NAME, PROP\_VALUE, MATERIAL\_AMOUNT
13
- This named entity recognition (NER) model was introduced in [this](https://www.nature.com/articles/s41524-023-01003-w) paper. Refer to this paper for a more detailed description of the entity types and performance metrics of this model. As MaterialsBERT is uncased, the NER model is also uncased.
14
 
15
  ## Intended uses & limitations
16
 
17
- You can use the model for sequence labeling/entity tagging tasks on materials science text. The training, validation and test data for this model consisted of abstracts related to polymers. The entities tagged by this model however are general and can be used with any materials science text to tag the entity types defined in the ontology of this model.
18
 
19
  ## How to Use
20
 
21
- Here is how to use this model to tag entities given some text:
22
 
23
  ```python
24
  from transformers import AutoModelForTokenClassification, AutoTokenizer, pipeline
 
9
 
10
  # PolymerNER
11
 
12
+ This model is a fine-tuned version of the MaterialsBERT model on a dataset of 638 abstracts and contains a linear layer on top of MaterialsBERT to predict the entity type of each token. The entity types predicted by this model are POLYMER, POLYMER\_FAMILY, ORGANIC, INORGANIC, MONOMER, PROP\_NAME, PROP\_VALUE, MATERIAL\_AMOUNT.
13
+ This named entity recognition (NER) model was introduced in [this](https://www.nature.com/articles/s41524-023-01003-w) paper. Refer to the paper for a more detailed description of the entity types and performance metrics of the model. As MaterialsBERT is uncased, the NER model is also uncased.
14
 
15
  ## Intended uses & limitations
16
 
17
+ You can use the model for sequence labeling/entity tagging tasks on materials science text. The training, validation and test data for the model consisted of abstracts related to polymers. The entities tagged by the model however are general and can be used with any materials science text to tag the entity types defined in the ontology of the model.
18
 
19
  ## How to Use
20
 
21
+ Here is how to use the model to tag entities given some text:
22
 
23
  ```python
24
  from transformers import AutoModelForTokenClassification, AutoTokenizer, pipeline