Update README.md

README.md

@@ -34,14 +34,32 @@ This model is a fine-tuned version of [bert-base-multilingual-uncased](https://h
 | Recall                 | **94.18** |
 
 
-### Training hyperparameters
+## Training hyperparameters
 
-The following hyperparameters were used during training:
-- optimizer: {'inner_optimizer': {'class_name': 'AdamWeightDecay', 'config': {'name': 'AdamWeightDecay', 'learning_rate': {'class_name': 'WarmUp', 'config': {'initial_learning_rate': 4e-05, 'decay_schedule_fn': {'class_name': 'PolynomialDecay', 'config': {'initial_learning_rate': 4e-05, 'decay_steps': 8248, 'end_learning_rate': 0.0, 'power': 1.0, 'cycle': False, 'name': None}, '__passive_serialization__': True}, 'warmup_steps': 500, 'power': 1.0, 'name': None}}, 'decay': 0.0, 'beta_1': 0.9, 'beta_2': 0.999, 'epsilon': 1e-08, 'amsgrad': False, 'weight_decay_rate': 0.01}}, 'dynamic': True, 'initial_scale': 32768.0, 'dynamic_growth_steps': 2000}
-- training_precision: mixed_float16
+- Optimizer = AdamW
+- LearningRate = 4e-5
+- WeightDecay = 1e-2
+- Warmup = 500
 
 
-### Framework versions
+## Example of usage
+
+```python 
+# pipeline example
+
+from transformers import pipeline
+
+model_checkpoint = "Sultannn/bert-base-ft-ner-xtreme-id"
+token_classifier = pipeline(
+    "token-classification", model=model_checkpoint, aggregation_strategy="simple")
+
+text = "nama saya Tono saya bekerja di Facebook dan tinggal di Jawa"
+
+token_classifier(text)
+
+```
+
+## Framework versions
 
 - Transformers 4.18.0
 - TensorFlow 2.8.0
@@ -50,3 +68,4 @@ The following hyperparameters were used during training:
 
 - [Fine-tune on NER script provided by @stefan-it](https://raw.githubusercontent.com/stefan-it/fine-tuned-berts-seq/master/scripts/preprocess.py)
 
+> Made with <span style="color: #e25555;">&hearts;</span> in Paris