Update README.md
Browse files
README.md
CHANGED
|
@@ -26,7 +26,7 @@ The general architecture and experimental results of BamiBERT can be found in ou
|
|
| 26 |
|
| 27 |
**Please CITE** our paper when BamiBERT is used to help produce published results or is incorporated into other software.
|
| 28 |
|
| 29 |
-
##
|
| 30 |
|
| 31 |
```python
|
| 32 |
# Using transformers<=5.5.0
|
|
@@ -35,12 +35,15 @@ tokenizer = AutoTokenizer.from_pretrained("Qualcomm-AI-Research/BamiBERT")
|
|
| 35 |
bamibert = AutoModel.from_pretrained("Qualcomm-AI-Research/BamiBERT")
|
| 36 |
```
|
| 37 |
|
| 38 |
-
##
|
| 39 |
|
| 40 |
-
Please find fine-tuning examples for
|
| 41 |
|
| 42 |
## License/Terms of Use
|
| 43 |
This model is released under the BSD 3-Clause Clear license and the Qualcomm responsible AI license: https://www.qualcomm.com/site/responsible-ai-license
|
| 44 |
|
| 45 |
## Uses
|
| 46 |
-
The model is intended for research purposes.
|
|
|
|
|
|
|
|
|
|
|
|
| 26 |
|
| 27 |
**Please CITE** our paper when BamiBERT is used to help produce published results or is incorporated into other software.
|
| 28 |
|
| 29 |
+
## Model Loading with `transformers`
|
| 30 |
|
| 31 |
```python
|
| 32 |
# Using transformers<=5.5.0
|
|
|
|
| 35 |
bamibert = AutoModel.from_pretrained("Qualcomm-AI-Research/BamiBERT")
|
| 36 |
```
|
| 37 |
|
| 38 |
+
## Model Fine-tuning
|
| 39 |
|
| 40 |
+
Please find fine-tuning examples for various downstream tasks, such as token classification (e.g., NER), text classification and question answering, using [transformers](https://github.com/huggingface/transformers/tree/main/examples/pytorch).
|
| 41 |
|
| 42 |
## License/Terms of Use
|
| 43 |
This model is released under the BSD 3-Clause Clear license and the Qualcomm responsible AI license: https://www.qualcomm.com/site/responsible-ai-license
|
| 44 |
|
| 45 |
## Uses
|
| 46 |
+
The model is intended for research and educational purposes.
|
| 47 |
+
|
| 48 |
+
## Limitations and Bias
|
| 49 |
+
BamiBERT is not designed for fluent text generation like GPT-style models. It may also suffer from temporal concept drift: although its pre-training corpus (cutoff December 2022) is more recent than those of other general-domain models (pre-2021), it may not reflect current language use. BamiBERT may also be biased toward standard Northern Vietnamese and underperform on Central and Southern dialects.
|