Update README.md

README.md

@@ -1,12 +1,19 @@
 ---
 library_name: transformers
-tags: []
+license: mit
+language:
+- en
+metrics:
+- accuracy
+base_model:
+- mistralai/Mistral-7B-Instruct-v0.3
+pipeline_tag: zero-shot-classification
 ---
 
 # Model Card for Model ID
 
 <!-- Provide a quick summary of what the model is/does. -->
-
+The Mistral 7B - Cause Analyzer is a fine-tuned large language model designed for analyzing server logs, categorizing errors, and providing debugging solutions. It is optimized for predictive maintenance tasks and can be integrated into tools like Splunk or Grafana for real-time operational insights.
 
 
 ## Model Details
@@ -15,23 +22,20 @@ tags: []
 
 <!-- Provide a longer summary of what this model is. -->
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+This model was fine-tuned on real-world and synthetic log data from Esperanto servers using the LoRA technique. It excels in automating error categorization and debugging recommendations, reducing manual intervention and improving server health monitoring.
+
+- **Developed by:** [Sivakrishna Yaganti, Shankar Jayaratnam]
+- **Funded by [optional]:** [Esperanto Technologies]
+- **Shared by [optional]:** [Sivakrishna Yaganti]
+- **Model type:** [Casual language model]
+- **Finetuned from model [optional]:** [Mistral 7B]
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
 
 ### Model Sources [optional]
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Repository:** https://huggingface.co/Esperanto/Mistral-7B-CauseAnalyzer
 
 ## Uses
 
@@ -41,7 +45,10 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
-[More Information Needed]
+The model can be used to analyze server logs for error categorization and debugging without additional fine-tuning. It is suitable for:
+1. Identifying patterns in server logs.
+2. Automating the process of error categorization.
+3. Generating debugging recommendations.
 
 ### Downstream Use [optional]
 
@@ -53,25 +60,40 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
-[More Information Needed]
+1. The model is not intended for general text generation tasks unrelated to server log analysis.
+2. It may not perform well on logs from domains significantly different from the training data.
 
 ## Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
+### Bias:
+1. The model's performance is optimized for logs similar to those in the training data. Logs with substantially different formats or languages may yield suboptimal results.
+
+### Risks:
+1. Over-reliance on model predictions without validation could lead to incorrect debugging actions.
+2. The model may fail to identify new or rare errors that were not part of the training data.
+
+### Limitations:
+1. The model assumes logs are in English.
+2. It may struggle with incomplete or highly noisy log data.
 
 ### Recommendations
 
 <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+1. Validate predictions with domain experts, especially in critical systems.
+2. Use the model alongside traditional debugging methods to ensure accuracy.
 
 ## How to Get Started with the Model
 
 Use the code below to get started with the model.
 
-[More Information Needed]
+### Load the model and tokenizer
+- model_name = "Esperanto/Mistral-7B-CauseAnalyzer" 
+- tokenizer = AutoTokenizer.from_pretrained(model_name)
+- model = AutoModelForCausalLM.from_pretrained(model_name)
+
 
 ## Training Details
 
@@ -79,7 +101,8 @@ Use the code below to get started with the model.
 
 <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
 
-[More Information Needed]
+- **Source:** Real-world logs from Esperanto servers augmented with synthetic logs generated using GPT-4.
+- **Size:** ~170 labeled samples after data augmentation.
 
 ### Training Procedure
 
@@ -87,8 +110,10 @@ Use the code below to get started with the model.
 
 #### Preprocessing [optional]
 
-[More Information Needed]
+1. Logs were structured into fields for error type, root cause, and debugging solution.
+2. Missing labels were generated using GPT-4 and manual verification.
 
+- **Fine-tuning method:** LoRA (Low-Rank Adaptation)
 
 #### Training Hyperparameters
 
@@ -110,27 +135,46 @@ Use the code below to get started with the model.
 
 <!-- This should link to a Dataset Card if possible. -->
 
-[More Information Needed]
+*Validation set:* 10% of labeled data.
 
 #### Factors
 
 <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
 
-[More Information Needed]
+Model performance was evaluated on:
+1. Error categorization accuracy.
+2. Cause similarity score (cosine similarity) between predicted and ground truth causes.
 
 #### Metrics
 
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]
+*Cause (Similarity Score):*
+1. Baseline Mistral 7B: 51.91
+2. Mistral-7B-CauseAnalyzer: 67.15
+
+*Error Categorization Accuracy:*
+1. Baseline Mistral 7B: 46.23%
+2. Mistral-7B-CauseAnalyzer: 70%
 
 ### Results
 
-[More Information Needed]
+#### Training and Validation Loss
+1. Training Loss decreased steadily from ~1 to 0.38, as shown in the train/loss graph.
+2. Evaluation Loss reduced from 0.6 to 0.3, indicating effective generalization.
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6659207a17951b5bd11a91fa/rh3jaw1F-IoIi7KGrgJc8.png)
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6659207a17951b5bd11a91fa/YIym3FFHDhVNJWie_vKSS.png)
 
 #### Summary
 
+The Fine-Tuned Mistral 7B - Cause Analyzer significantly outperforms the baseline models, achieving:
+1. A 67.15 similarity score for cause prediction.
+2. A 70% accuracy in error categorization.
 
+These results highlight the model's robustness in predictive maintenance tasks and its potential for real-world integration into server health monitoring systems.
+-*Had it been finetuned with more data, could have given better results.*
 
 ## Model Examination [optional]
 
@@ -154,7 +198,9 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ### Model Architecture and Objective
 
-[More Information Needed]
+- **Architecture:** Mistral 7B causal language model.
+- **Objective:** Fine-tuned for error categorization and debugging solutions in server logs.
+
 
 ### Compute Infrastructure
 
@@ -162,11 +208,11 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 #### Hardware
 
-[More Information Needed]
+Nvidia A100 and Esperanto Accelerators
 
 #### Software
 
-[More Information Needed]
+Hugging Face Transformers library.
 
 ## Citation [optional]
 
@@ -192,8 +238,8 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ## Model Card Authors [optional]
 
-[More Information Needed]
+Sivakrishna Yaganti, Shankar Jayaratnam
 
 ## Model Card Contact
 
-[More Information Needed]
+[email protected]