Update README.md
Browse files
README.md
CHANGED
|
@@ -32,32 +32,18 @@ should probably proofread and complete it, then remove this comment. -->
|
|
| 32 |
|
| 33 |
This model is a fine-tuned version of [distilbert-base-cased](https://huggingface.co/distilbert-base-cased) on [ai4privacy/pii-masking-300k](https://huggingface.co/datasets/ai4privacy/pii-masking-300k).
|
| 34 |
|
| 35 |
-
|
|
|
|
|
|
|
| 36 |
|
| 37 |
-
|
|
|
|
|
|
|
| 38 |
|
| 39 |
-
|
| 40 |
|
| 41 |
-
More information needed
|
| 42 |
|
| 43 |
-
## Training and evaluation data
|
| 44 |
|
| 45 |
-
More information needed
|
| 46 |
-
|
| 47 |
-
## Training procedure
|
| 48 |
-
|
| 49 |
-
### Training hyperparameters
|
| 50 |
-
|
| 51 |
-
The following hyperparameters were used during training:
|
| 52 |
-
- learning_rate: 2e-05
|
| 53 |
-
- train_batch_size: 64
|
| 54 |
-
- eval_batch_size: 128
|
| 55 |
-
- seed: 42
|
| 56 |
-
- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
|
| 57 |
-
- lr_scheduler_type: cosine
|
| 58 |
-
- lr_scheduler_warmup_ratio: 0.2
|
| 59 |
-
- lr_scheduler_warmup_steps: 3000
|
| 60 |
-
- training_steps: 20000
|
| 61 |
|
| 62 |
### Training results
|
| 63 |
|
|
|
|
| 32 |
|
| 33 |
This model is a fine-tuned version of [distilbert-base-cased](https://huggingface.co/distilbert-base-cased) on [ai4privacy/pii-masking-300k](https://huggingface.co/datasets/ai4privacy/pii-masking-300k).
|
| 34 |
|
| 35 |
+
Usage:
|
| 36 |
+
```
|
| 37 |
+
from transformers import pipeline
|
| 38 |
|
| 39 |
+
pipe = pipeline("token-classification", model="yonigo/distilbert-base-cased-pii-en", aggregation_strategy="first")
|
| 40 |
+
pipe("My name is Yoni Go and I live in Israel. My phone number is 054-1234567")
|
| 41 |
+
```
|
| 42 |
|
| 43 |
+
training code [git](https://github.com/yonigottesman/pii-model)
|
| 44 |
|
|
|
|
| 45 |
|
|
|
|
| 46 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 47 |
|
| 48 |
### Training results
|
| 49 |
|