mvansegbroeck
commited on
Update README.md
Browse files
README.md
CHANGED
@@ -17,16 +17,9 @@ tags:
|
|
17 |
---
|
18 |
|
19 |
# Gretel GLiNER: Fine-Tuned Models for PII/PHI Detection
|
20 |
-
**Gretel GLiNER** is a
|
21 |
Gretel GLiNER helps to provide privacy-compliant entity recognition across various industries and document types.
|
22 |
-
|
23 |
-
|
24 |
-
- **Fine-Tuned Models:**
|
25 |
-
- `gretelai/gretel-gliner-bi-small-v1.0`
|
26 |
-
- `gretelai/gretel-gliner-bi-base-v1.0`
|
27 |
-
- `gretelai/gretel-gliner-bi-large-v1.0`
|
28 |
-
|
29 |
-
For more information about the base GLiNER model, including its architecture and general capabilities, please refer to the [GLiNER Model Card](https://huggingface.co/knowledgator/gliner-bi-base-v1.0).
|
30 |
|
31 |
The model was fine-tuned on the `gretelai/gretel-pii-masking-en-v1` dataset, which provides a rich and diverse collection of synthetic document snippets containing PII and PHI entities.
|
32 |
|
@@ -38,7 +31,7 @@ For detailed statistics on the dataset, including domain and entity type distrib
|
|
38 |
|
39 |
### Model Performance
|
40 |
|
41 |
-
|
42 |
|
43 |
| Model | Accuracy | Precision | Recall | F1 Score |
|
44 |
|---------------------------------------|----------|-----------|--------|----------|
|
@@ -61,7 +54,7 @@ Load the fine-tuned Gretel GLiNER model using the GLiNER class and the from_pret
|
|
61 |
from gliner import GLiNER
|
62 |
|
63 |
# Load the fine-tuned GLiNER model
|
64 |
-
model = GLiNER.from_pretrained("gretelai/gretel-gliner-bi-
|
65 |
|
66 |
# Sample text containing PII/PHI entities
|
67 |
text = """
|
|
|
17 |
---
|
18 |
|
19 |
# Gretel GLiNER: Fine-Tuned Models for PII/PHI Detection
|
20 |
+
This **Gretel GLiNER** model is a fine-tuned version of the GLiNER base model `knowledgator/gliner-bi-large-v1.0`, specifically trained for the detection of Personally Identifiable Information (PII) and Protected Health Information (PHI).
|
21 |
Gretel GLiNER helps to provide privacy-compliant entity recognition across various industries and document types.
|
22 |
+
For more information about the base GLiNER model, including its architecture and general capabilities, please refer to the [GLiNER Model Card](https://huggingface.co/knowledgator/gliner-bi-large-v1.0).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
23 |
|
24 |
The model was fine-tuned on the `gretelai/gretel-pii-masking-en-v1` dataset, which provides a rich and diverse collection of synthetic document snippets containing PII and PHI entities.
|
25 |
|
|
|
31 |
|
32 |
### Model Performance
|
33 |
|
34 |
+
All fine-tuned Gretel GLiNER models demonstrate substantial improvements over their base counterparts in accuracy, precision, recall, and F1 score:
|
35 |
|
36 |
| Model | Accuracy | Precision | Recall | F1 Score |
|
37 |
|---------------------------------------|----------|-----------|--------|----------|
|
|
|
54 |
from gliner import GLiNER
|
55 |
|
56 |
# Load the fine-tuned GLiNER model
|
57 |
+
model = GLiNER.from_pretrained("gretelai/gretel-gliner-bi-large-v1.0")
|
58 |
|
59 |
# Sample text containing PII/PHI entities
|
60 |
text = """
|