Updated model card

README.md

@@ -3,199 +3,121 @@ library_name: transformers
 tags: []
 ---
 
-# Model Card for Model ID
-
-<!-- Provide a quick summary of what the model is/does. -->
-Will be updated soon
-
+# Model Card for LLaMAdelic
 
+<!-- Summary of model purpose and objective -->
+The LLaMAdelic model was fine-tuned to generate conversations with personality-specific adaptations based on the Big 5 personality traits: Openness, Conscientiousness, Extraversion, Agreeableness, and Neuroticism. The model was trained on conversational data, specifically designed to enhance its capacity for personality-driven dialogue. Detailed information about the dataset will be updated soon.
 
 ## Model Details
 Will be updated soon
 
 ### Model Description
 
-<!-- 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.
-
-- **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]
+This is the model card for the fine-tuned LLaMAdelic model on the 🤗 Hub.
 
-### Model Sources [optional]
+- **Developed by:** Will be updated soon
+- **Funded by [optional]:** Will be updated soon
+- **Shared by [optional]:** Will be updated soon
+- **Model type:** Fine-tuned LLaMA 3 8B Instruct
+- **Language(s) (NLP):** English
+- **License:** Will be updated soon
+- **Finetuned from model:** [LLaMA 3 8B Instruct](https://huggingface.co/meta-llama/Meta-Llama-3-8B-Instruct)
 
-<!-- Provide the basic links for the model. -->
+### Model Sources
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Repository:** Will be updated soon
+- **Paper [optional]:** Will be updated soon
+- **Demo [optional]:** Will be updated soon
 
 ## Uses
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
 ### Direct Use
+Will be updated soon
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
+### Downstream Use
+Will be updated soon
 
 ### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
+Will be updated soon
 
 ## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+Will be updated soon
 
 ### 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.
+Users (both direct and downstream) should be aware of potential biases and limitations. Further recommendations will be updated soon.
 
 ## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
+Will be updated soon
 
 ## Training Details
 
 ### Training Data
-
-<!-- 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]
+Will be updated soon
 
 ### Training Procedure
 
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
+#### Preprocessing
+Will be updated soon
 
 #### Training Hyperparameters
+Will be updated soon
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
+#### Speeds, Sizes, Times
+Will be updated soon
 
 ## Evaluation
 
-<!-- This section describes the evaluation protocols and provides the results. -->
-
 ### Testing Data, Factors & Metrics
 
 #### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
+Will be updated soon
 
 #### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
+Will be updated soon
 
 #### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
+Will be updated soon
 
 ### Results
 
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
+The results from the [EleutherAI/lm-evaluation-harness](https://github.com/EleutherAI/lm-evaluation-harness) for OCEAN personality benchmarks show notable improvements in personality-specific scores for the LLaMAdelic model over the zeroshot pre-trained LLaMA 8B instruct model. Detailed evaluation results are below:
 
-<!-- Relevant interpretability work for the model goes here -->
+| Model            | Description                        | Openness | Conscientiousness | Extraversion | Agreeableness | Neuroticism | Avg  |
+|------------------|------------------------------------|----------|-------------------|--------------|---------------|-------------|------|
+| LLaMA 8B ins     | Zeroshot                           | 0.8760   |       0.7620      |    0.7170    |    0.9500     |    0.5220   |0.7654|
+| LLaMAdelic       | Finetuned on Conversational Data   | 0.9150   |       0.7840      |    0.6680    |    0.9440     |    0.7040   |0.8030|
 
-[More Information Needed]
+## Model Examination
+Will be updated soon
 
 ## Environmental Impact
+Will be updated soon
 
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
+## Technical Specifications
 
 ### Model Architecture and Objective
-
-[More Information Needed]
+Will be updated soon
 
 ### Compute Infrastructure
-
-[More Information Needed]
+Will be updated soon
 
 #### Hardware
-
-[More Information Needed]
+Will be updated soon
 
 #### Software
+Will be updated soon
 
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
+## Citation
+Will be updated soon
 
-[More Information Needed]
+## Glossary
+Will be updated soon
 
-## Model Card Authors [optional]
+## More Information
+Will be updated soon
 
-[More Information Needed]
+## Model Card Authors
+Will be updated soon
 
 ## Model Card Contact
-
-[More Information Needed]
+Will be updated soon