botryan96 commited on
Commit
d5ef33b
1 Parent(s): 053d558

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -60
README.md CHANGED
@@ -1,60 +0,0 @@
1
- ---
2
- tags:
3
- - generated_from_keras_callback
4
- model-index:
5
- - name: GeoBERT
6
- results: []
7
- ---
8
-
9
- <!-- This model card has been generated automatically according to the information Keras had access to. You should
10
- probably proofread and complete it, then remove this comment. -->
11
-
12
- # GeoBERT
13
-
14
- GeoBERT is a NER model that was fine-tuned from SciBERT on the Geoscientific Corpus dataset.
15
- The model was trained on the Labeled Geoscientific Corpus dataset (~1 million sentences).
16
-
17
-
18
- ## Intended uses
19
-
20
- The NER product in this model has a goal to identify four main semantic types or categories related to Geosciences.
21
-
22
- 1. GeoPetro for any entities that belong to all terms in Geosciences
23
- 2. GeoMeth for all tools or methods associated with Geosciences
24
- 3. GeoLoc to identify geological locations
25
- 4. GeoTime for identifying the geological time scale entities
26
-
27
-
28
- ### Training hyperparameters
29
-
30
- The following hyperparameters were used during training:
31
- - optimizer: {'name': 'AdamWeightDecay', 'learning_rate': {'class_name': 'PolynomialDecay', 'config': {'initial_learning_rate': 2e-05, 'decay_steps': 14000, 'end_learning_rate': 0.0, 'power': 1.0, 'cycle': False, 'name': None}}, 'decay': 0.0, 'beta_1': 0.9, 'beta_2': 0.999, 'epsilon': 1e-08, 'amsgrad': False, 'weight_decay_rate': 0.01}
32
- - training_precision: mixed_float16
33
-
34
-
35
- ### Framework versions
36
-
37
- - Transformers 4.22.1
38
- - TensorFlow 2.10.0
39
- - Datasets 2.4.0
40
- - Tokenizers 0.12.1
41
-
42
- ## Model performances (metric: seqeval)
43
-
44
- entity|precision|recall|f1
45
- -|-|-|-
46
- GeoLoc |0.9727|0.9591|0.9658
47
- GeoMeth |0.9433|0.9447|0.9445
48
- GeoPetro|0.9767|0.9745|0.9756
49
- GeoTime |0.9695|0.9666|0.9680
50
-
51
- ## How to use GeoBERT with HuggingFace
52
-
53
- ##### Load GeoBERT and its sub-word tokenizer :
54
-
55
- ```python
56
- from transformers import AutoTokenizer, AutoModelForTokenClassification
57
-
58
- tokenizer = AutoTokenizer.from_pretrained("botryan96/GeoBERT")
59
- model = AutoModelForTokenClassification.from_pretrained("botryan96/GeoBERT")
60
- ```