optimopium commited on
Commit
0c106a6
·
verified ·
1 Parent(s): be73683

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +41 -8
README.md CHANGED
@@ -1,14 +1,47 @@
1
  ---
2
- title: NER Persian LLM Based
3
- emoji: 📊
4
- colorFrom: gray
5
- colorTo: gray
6
  sdk: gradio
7
- sdk_version: 5.49.1
8
  app_file: app.py
9
  pinned: false
10
- license: mit
11
- short_description: Zero-shot Persian Named Entity Recognition using an instruct
12
  ---
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: Persian NER
3
+ colorFrom: green
4
+ colorTo: blue
 
5
  sdk: gradio
6
+ sdk_version: 4.44.0
7
  app_file: app.py
8
  pinned: false
 
 
9
  ---
10
 
11
+ # Persian Named Entity Recognition (NER)
12
+
13
+ This space performs Named Entity Recognition on Persian (Farsi) text using the ParsBERT model.
14
+
15
+ ## Features
16
+ - Identifies person names, organizations, locations, dates, times, money, and percentages
17
+ - Highlights entities with color-coding
18
+ - Runs on CPU (no GPU required)
19
+ - Provides confidence scores for each detected entity
20
+
21
+ ## Model
22
+ - **Model**: HooshvareLab/bert-base-parsbert-ner-uncased
23
+ - **Framework**: Transformers + PyTorch
24
+ - **Language**: Persian (Farsi)
25
+
26
+ ## Usage
27
+ Simply enter Persian text in the input box and click "Analyze Text" to see the detected entities highlighted in the text.
28
+
29
+ ## Entity Types
30
+ - **PER** (شخص): Person names
31
+ - **ORG** (سازمان): Organizations
32
+ - **LOC** (مکان): Locations
33
+ - **DAT** (تاریخ): Dates
34
+ - **TIM** (زمان): Times
35
+ - **MON** (پول): Money amounts
36
+ - **PCT** (درصد): Percentages
37
+
38
+ ## Citation
39
+ ```bibtex
40
+ @article{ParsBERT,
41
+ title={ParsBERT: Transformer-based Model for Persian Language Understanding},
42
+ author={Mehrdad Farahani, Mohammad Gharachorloo, Marzieh Farahani, Mohammad Manthouri},
43
+ journal={ArXiv},
44
+ year={2020},
45
+ volume={abs/2005.12515}
46
+ }
47
+ ```