Update README.md
Browse files
README.md
CHANGED
|
@@ -23,4 +23,30 @@ Domain Specific BERT model for Text Mining in Energy & Material Field
|
|
| 23 |
<!-- Provide the basic links for the model. -->
|
| 24 |
|
| 25 |
- **Repository:** [Github](https://github.com/MasterAI-EAM/EnergyBERT)
|
| 26 |
-
- **Paper:**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 23 |
<!-- Provide the basic links for the model. -->
|
| 24 |
|
| 25 |
- **Repository:** [Github](https://github.com/MasterAI-EAM/EnergyBERT)
|
| 26 |
+
- **Paper:** [Under Prepreation]
|
| 27 |
+
|
| 28 |
+
# Uses
|
| 29 |
+
|
| 30 |
+
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 31 |
+
|
| 32 |
+
## Direct Use
|
| 33 |
+
|
| 34 |
+
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 35 |
+
|
| 36 |
+
Text Mining in Energy & Material Fields
|
| 37 |
+
|
| 38 |
+
## Downstream Use
|
| 39 |
+
|
| 40 |
+
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 41 |
+
|
| 42 |
+
The EnergyBERT model can be expanded way beyond just text classification. It can be fine-tuned to perform various other downstream NLP tasks in the domain of Energy & Material
|
| 43 |
+
|
| 44 |
+
## How to Get Started with the Model
|
| 45 |
+
|
| 46 |
+
Use the code below to get started with the model.
|
| 47 |
+
|
| 48 |
+
```python
|
| 49 |
+
from transformers import pipeline
|
| 50 |
+
unmasker = pipeline('fill-mask', model='EnergyBERT')
|
| 51 |
+
unmasker("Hello I'm a <mask> model.")
|
| 52 |
+
```
|