huggingsaurusRex commited on
Commit
98c17d3
1 Parent(s): f17ac98

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +34 -2
README.md CHANGED
@@ -4,7 +4,39 @@ datasets:
4
  language:
5
  - en
6
  metrics:
7
- - f1
8
  - precision
9
  - recall
10
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
  language:
5
  - en
6
  metrics:
7
+ - f1=0.87
8
  - precision
9
  - recall
10
+ ---
11
+ # HuggingsaurusRex/bert-base-uncased-for-mountain-ner
12
+
13
+ ## Purpose
14
+ Detect mountain names in text using token classification.
15
+
16
+ ## Usage
17
+ ```python
18
+ from transformers import AutoModelForTokenClassification, AutoTokenizer, pipeline
19
+
20
+ # Load model and tokenizer
21
+ model = AutoModelForTokenClassification.from_pretrained('huggingsaurusRex/bert-base-uncased-for-mountain-ner')
22
+ tokenizer = AutoTokenizer.from_pretrained('huggingsaurusRex/bert-base-uncased-for-mountain-ner')
23
+
24
+ # Create NER pipeline
25
+ ner = pipeline('ner', model=model, tokenizer=tokenizer)
26
+
27
+ # Perform inference
28
+ res = ner("I spent days climbing the Mount Everest.")
29
+ print(res)
30
+ ```
31
+
32
+ ## Architecture
33
+ The model is a BERT-based token classification model fine-tuned on the Few-NERD dataset.
34
+
35
+ ## Results
36
+ - F1-Score: 0.87
37
+ - Precision: 0.84
38
+ - Recall: 0.91
39
+
40
+ ## Direct Link
41
+ [HuggingsaurusRex/bert-base-uncased-for-mountain-ner](https://huggingface.co/huggingsaurusRex/bert-base-uncased-for-mountain-ner)
42
+