Update README.md
Browse files
README.md
CHANGED
|
@@ -7,22 +7,22 @@ metrics:
|
|
| 7 |
- accuracy
|
| 8 |
pipeline_tag: text2text-generation
|
| 9 |
---
|
| 10 |
-
|
| 11 |
The Grammar Correction T5 Model is based on the T5 (Text-to-Text Transfer Transformer) architecture, leveraging the power of pre-trained models from Hugging Face. The model has been fine-tuned on grammar correction tasks, enabling it to take input text with grammatical errors and provide corrected output, along with a detailed list of corrections and their count.
|
| 12 |
|
| 13 |
-
|
| 14 |
The primary use case for this model is to enhance the grammatical correctness of input text. It serves as a valuable tool for content creators, writers, and individuals seeking to improve the quality of written content. The model is particularly useful in applications where clear and error-free communication is essential, such as in document preparation, content editing, and educational materials.
|
| 15 |
|
| 16 |
-
|
| 17 |
Using the Grammar Correction T5 Model is straightforward:
|
| 18 |
|
| 19 |
-
Input Format:
|
| 20 |
Provide a text input that contains grammatical errors. The model is designed to handle a variety of grammatical issues, including syntax, tense, and word usage errors.
|
| 21 |
|
| 22 |
-
Output:
|
| 23 |
The model generates corrected text, highlighting the corrections made. Additionally, it provides a list of words that were corrected and the overall count of corrections.
|
| 24 |
|
| 25 |
-
Model Deployment:
|
| 26 |
Deploy the model easily using the Hugging Face inference API. Users can leverage the API to integrate the grammar correction capability into their applications, websites, or text processing pipelines.
|
| 27 |
|
| 28 |
By incorporating the Grammar Correction T5 Model, users can enhance the accuracy and clarity of written content, ultimately improving the overall quality of text-based communication.
|
|
@@ -32,23 +32,11 @@ By incorporating the Grammar Correction T5 Model, users can enhance the accuracy
|
|
| 32 |
|
| 33 |
```python
|
| 34 |
from transformers import pipeline
|
| 35 |
-
|
| 36 |
# Load the Grammar Correction T5 Model from Hugging Face
|
| 37 |
grammar_correction_model = pipeline(task="text2text-generation", model="hassaanik/grammar-correction-model")
|
| 38 |
-
|
| 39 |
# Input text with grammatical errors
|
| 40 |
input_text = "They is going to spent time together."
|
| 41 |
-
|
| 42 |
# Get corrected output and details
|
| 43 |
result = grammar_correction_model(input_text, max_length=200, num_beams=5, no_repeat_ngram_size=2)
|
| 44 |
-
|
| 45 |
# Print the corrected output
|
| 46 |
print(result)
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
|
|
|
|
| 7 |
- accuracy
|
| 8 |
pipeline_tag: text2text-generation
|
| 9 |
---
|
| 10 |
+
Summary of the Model:
|
| 11 |
The Grammar Correction T5 Model is based on the T5 (Text-to-Text Transfer Transformer) architecture, leveraging the power of pre-trained models from Hugging Face. The model has been fine-tuned on grammar correction tasks, enabling it to take input text with grammatical errors and provide corrected output, along with a detailed list of corrections and their count.
|
| 12 |
|
| 13 |
+
Uses of the Model:
|
| 14 |
The primary use case for this model is to enhance the grammatical correctness of input text. It serves as a valuable tool for content creators, writers, and individuals seeking to improve the quality of written content. The model is particularly useful in applications where clear and error-free communication is essential, such as in document preparation, content editing, and educational materials.
|
| 15 |
|
| 16 |
+
How to Use It:
|
| 17 |
Using the Grammar Correction T5 Model is straightforward:
|
| 18 |
|
| 19 |
+
-Input Format:
|
| 20 |
Provide a text input that contains grammatical errors. The model is designed to handle a variety of grammatical issues, including syntax, tense, and word usage errors.
|
| 21 |
|
| 22 |
+
-Output:
|
| 23 |
The model generates corrected text, highlighting the corrections made. Additionally, it provides a list of words that were corrected and the overall count of corrections.
|
| 24 |
|
| 25 |
+
-Model Deployment:
|
| 26 |
Deploy the model easily using the Hugging Face inference API. Users can leverage the API to integrate the grammar correction capability into their applications, websites, or text processing pipelines.
|
| 27 |
|
| 28 |
By incorporating the Grammar Correction T5 Model, users can enhance the accuracy and clarity of written content, ultimately improving the overall quality of text-based communication.
|
|
|
|
| 32 |
|
| 33 |
```python
|
| 34 |
from transformers import pipeline
|
|
|
|
| 35 |
# Load the Grammar Correction T5 Model from Hugging Face
|
| 36 |
grammar_correction_model = pipeline(task="text2text-generation", model="hassaanik/grammar-correction-model")
|
|
|
|
| 37 |
# Input text with grammatical errors
|
| 38 |
input_text = "They is going to spent time together."
|
|
|
|
| 39 |
# Get corrected output and details
|
| 40 |
result = grammar_correction_model(input_text, max_length=200, num_beams=5, no_repeat_ngram_size=2)
|
|
|
|
| 41 |
# Print the corrected output
|
| 42 |
print(result)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|