ProfessorLeVesseur commited on
Commit
084b37d
·
verified ·
1 Parent(s): 1f8f953

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +12 -12
README.md CHANGED
@@ -46,34 +46,34 @@ evaluation_results:
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
- ## Intended Use
54
 
55
  This model can be used in applications such as:
56
  - Identifying if statements are discussing past needs, motivations, products, etc. ⏪
57
  - Determining current events or situations in text. ⏺️
58
  - Predicting future plans or intentions based on sentence structure. ⏩
59
 
60
- ### Example Sentences and Labels
61
 
62
  | Sentence | Label |
63
  |--------------------------------------------------------------------------|---------|
64
- | the fishermen had caught a variety of fish including bass and perch | Past |
65
- | medical professionals are researching the impact of social determinants on health | Present |
66
- | in the future robotic surgical systems will have been empowering surgeons to perform increasingly complex procedures | Future |
67
 
68
- ## Training Details
69
 
70
  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.
71
 
72
- ## Evaluation Results
73
 
74
  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.
75
 
76
- ### Classification Report
77
 
78
  | Class | Precision | Recall | F1-Score | Support |
79
  |-------------|-----------|--------|----------|---------|
@@ -84,11 +84,11 @@ The model achieves a **perfect accuracy of 1.00** on the test set, with **precis
84
  | **Macro Avg** | 1.00 | 1.00 | 1.00 | 1998 |
85
  | **Weighted Avg** | 1.00 | 1.00 | 1.00 | 1998 |
86
 
87
- ### Limitations
88
 
89
  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.
90
 
91
- ## How to Use
92
 
93
  ```python
94
  from transformers import pipeline
 
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
+ ## Intended Use 🔍
54
 
55
  This model can be used in applications such as:
56
  - Identifying if statements are discussing past needs, motivations, products, etc. ⏪
57
  - Determining current events or situations in text. ⏺️
58
  - Predicting future plans or intentions based on sentence structure. ⏩
59
 
60
+ ### Example Sentences and Labels 📝
61
 
62
  | Sentence | Label |
63
  |--------------------------------------------------------------------------|---------|
64
+ | the fishermen had caught a variety of fish including bass and perch | Past |
65
+ | medical professionals are researching the impact of social determinants on health | Present ⏺️ |
66
+ | in the future robotic surgical systems will have been empowering surgeons to perform increasingly complex procedures | Future|
67
 
68
+ ## Training Details 🏋️‍♂️
69
 
70
  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.
71
 
72
+ ## Evaluation Results 📊
73
 
74
  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.
75
 
76
+ ### Classification Report
77
 
78
  | Class | Precision | Recall | F1-Score | Support |
79
  |-------------|-----------|--------|----------|---------|
 
84
  | **Macro Avg** | 1.00 | 1.00 | 1.00 | 1998 |
85
  | **Weighted Avg** | 1.00 | 1.00 | 1.00 | 1998 |
86
 
87
+ ### Limitations ⚠️
88
 
89
  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.
90
 
91
+ ## How to Use 🚀
92
 
93
  ```python
94
  from transformers import pipeline