Update README.md
Browse files
README.md
CHANGED
|
@@ -44,4 +44,36 @@ evaluation_results:
|
|
| 44 |
Future: 727
|
| 45 |
Past: 577
|
| 46 |
Present: 694
|
| 47 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 44 |
Future: 727
|
| 45 |
Past: 577
|
| 46 |
Present: 694
|
| 47 |
+
---
|
| 48 |
+
|
| 49 |
+
## Model Overview
|
| 50 |
+
|
| 51 |
+
This model is a text classification model trained to predict the tense of English sentences: Past, Present, or Future. It is based on the `bert-base-uncased` architecture.
|
| 52 |
+
|
| 53 |
+
## Training Details
|
| 54 |
+
|
| 55 |
+
The model was fine-tuned on the `ProfessorLeVesseur/EnglishTense` dataset, which provides a diverse set of sentences labeled with their respective tenses. The training involved optimizing the model's weights for three epochs using a learning rate of 5e-5.
|
| 56 |
+
|
| 57 |
+
## Evaluation Results
|
| 58 |
+
|
| 59 |
+
The model achieves a perfect accuracy of 1.00 on the test set, with precision, recall, and F1-scores also at 1.00 for all classes. These results indicate excellent performance in classifying sentence tenses.
|
| 60 |
+
|
| 61 |
+
## Intended Use
|
| 62 |
+
|
| 63 |
+
This model can be used in applications such as:
|
| 64 |
+
- Identifying if statements are discussing past needs, motivations, products, etc.
|
| 65 |
+
- Determining current events or situations in text.
|
| 66 |
+
- Predicting future plans or intentions based on sentence structure.
|
| 67 |
+
|
| 68 |
+
### Limitations
|
| 69 |
+
|
| 70 |
+
While the model performs well on the provided dataset, it may not generalize to all types of English text, particularly those with ambiguous or complex sentence structures.
|
| 71 |
+
|
| 72 |
+
## How to Use
|
| 73 |
+
|
| 74 |
+
```python
|
| 75 |
+
from transformers import pipeline
|
| 76 |
+
|
| 77 |
+
classifier = pipeline("text-classification", model="your-username/your-model-name")
|
| 78 |
+
result = classifier("The meeting will take place tomorrow.")
|
| 79 |
+
print(result)
|