Update README.md

README.md

@@ -8,56 +8,78 @@ tags:
 datasets:
 - disham993/ElectricalDeviceFeedbackBalanced
 metrics:
-- epoch: 1.0
+- epoch: 1
 - eval_f1: 0.8353275880967258
 - eval_accuracy: 0.856508875739645
 - eval_runtime: 0.4632
 - eval_samples_per_second: 2918.69
 - eval_steps_per_second: 47.493
+library_name: transformers
 ---
 
 # disham993/electrical-classification-distilbert-base-uncased
 
 ## Model description
 
-This model is fine-tuned from [distilbert/distilbert-base-uncased](https://huggingface.co/distilbert/distilbert-base-uncased) for text-classification tasks.
+This model is fine-tuned from [distilbert/distilbert-base-uncased](https://huggingface.co/distilbert/distilbert-base-uncased) for text classification tasks, specifically sentiment analysis of customer feedback on electrical devices - circuit breakers, transformers, smart meters, inverters, solar panels, power strips etc. The model has been optimized to classify sentiments into categories such as Positive, Negative, Neutral, and Mixed with high precision and recall, making it ideal for analyzing product reviews, customer surveys, and other feedback to derive actionable insights.
 
 ## Training Data
 
-The model was trained on the disham993/ElectricalDeviceFeedbackBalanced dataset. 
+The model was trained on the [disham993/ElectricalDeviceFeedbackBalanced](https://huggingface.co/datasets/disham993/ElectricalDeviceFeedbackBalanced) dataset, which has been carefully balanced to address class imbalances effectively.
 
 ## Model Details
-- **Base Model:** distilbert/distilbert-base-uncased
+- **Base Model:** [distilbert/distilbert-base-uncased](https://huggingface.co/distilbert/distilbert-base-uncased) 
 - **Task:** text-classification
 - **Language:** en
-- **Dataset:** disham993/ElectricalDeviceFeedbackBalanced
+- **Dataset:** [disham993/ElectricalDeviceFeedbackBalanced](https://huggingface.co/datasets/disham993/ElectricalDeviceFeedbackBalanced)
 
 ## Training procedure
 
 ### Training hyperparameters
-[Please add your training hyperparameters here]
+
+The model was fine-tuned using the following hyperparameters:
+
+- **Evaluation Strategy:** epoch
+- **Learning Rate:** 1e-5
+- **Batch Size:** 64 (for both training and evaluation)
+- **Number of Epochs:** 5
+- **Weight Decay:** 0.01
 
 ## Evaluation results
 
-### Metrics\n- epoch: 1.0\n- eval_f1: 0.8353275880967258\n- eval_accuracy: 0.856508875739645\n- eval_runtime: 0.4632\n- eval_samples_per_second: 2918.69\n- eval_steps_per_second: 47.493
+The following metrics were achieved during evaluation:
+
+- **F1 Score:** 0.8899
+- **Accuracy:** 0.8875
+- **eval_runtime**: 1.2105
+- **eval_samples_per_second**: 1116.881
+- **eval_steps_per_second**: 18.174
 
 ## Usage
 
 ```python
-from transformers import AutoTokenizer, AutoModel
+from transformers import AutoTokenizer, AutoModelForSequenceClassification, pipeline
 
-tokenizer = AutoTokenizer.from_pretrained("disham993/electrical-classification-distilbert-base-uncased")
-model = AutoModel.from_pretrained("disham993/electrical-classification-distilbert-base-uncased")
+model_name = "disham993/electrical-classification-distilbert-base"
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+model = AutoModelForSequenceClassification.from_pretrained(model_name)
+nlp = pipeline("text-classification", model=model, tokenizer=tokenizer)
+
+text = "The new washing machine is efficient but produces a bit of noise."
+classification_results = nlp(text)
+print(classification_results)
 ```
 
 ## Limitations and bias
 
-[Add any known limitations or biases of the model]
+The dataset includes synthetic data generated using Llama 3.1:8b, and despite careful optimization and prompt engineering, the model is not immune to errors in labeling. Additionally, as LLM technology is still in its early stages, there may be inherent inaccuracies or biases in the generated data that can impact the model's performance.
+
+This model is intended for research and educational purposes only, and users are encouraged to validate results before applying them to critical applications.
 
 ## Training Infrastructure
 
-[Add details about training infrastructure used]
+For a complete guide covering the entire process - from data tokenization to pushing the model to the Hugging Face Hub - please refer to the [GitHub repository](https://github.com/di37/classification-electrical-feedback-finetuning).
 
 ## Last update
 
-2025-01-05
+2025-01-05