Update README.md (#1)

- Update README.md (f48ea95003214db570e5c5abef88ce2b374fd2e5)


Co-authored-by: Daria Kotova <daha-kot@users.noreply.huggingface.co>

README.md

@@ -1,76 +1,58 @@
 ---
 library_name: peft
 base_model: mistralai/Mistral-7B-v0.1
+license: mit
+language:
+- en
+metrics:
+- perplexity
+- bertscore
 ---
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
+Fine-tuned using QLoRA for story generation task.
 
 
-
-## Model Details
-
 ### Model Description
 
-<!-- Provide a longer summary of what this model is. -->
-
-
-
-- **Developed by:** [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]
+We utilize "Hierarchical Neural Story Generation" dataset and fine-tune the model to generate stories.
 
-## Uses
+The input to the model is structred as follows:
 
-<!-- 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
+\#\#\# Instruction:  Below is a story idea. Write a short story based on this context.
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+\#\#\# Input: [story idea here]
 
-[More Information Needed]
+\#\#\# Response:
 
-### 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]
+- **Developed by:** Abdelrahman ’Boda’ Sadallah, Anastasiia Demidova, Daria Kotova
+- **Model type:** Causal LM
+- **Language(s) (NLP):** English
+- **Finetuned from model [optional]:** mistralai/Mistral-7B-v0.1
 
-### Out-of-Scope Use
+### Model Sources
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+- **Repository:** https://github.com/BodaSadalla98/llm-optimized-fintuning
 
-[More Information Needed]
+## Uses
 
-## Bias, Risks, and Limitations
+<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+The model is the result of our AI project. If you intend to use it, please, refer to the repo.
 
-[More Information Needed]
 
 ### 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.
+For improving stories generation, you can play parameters: temeperature, top_p/top_k, repetition_penalty, etc.
 
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
 
 ## Training Details
 
@@ -78,26 +60,8 @@ Use the code below to get started with the model.
 
 <!-- This should link to a Data 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]
-
-### Training Procedure 
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+Github for the dataset: https://github.com/kevalnagda/StoryGeneration
 
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **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]
 
 ## Evaluation
 
@@ -105,98 +69,20 @@ Use the code below to get started with the model.
 
 ### Testing Data, Factors & Metrics
 
-#### Testing Data
-
-<!-- This should link to a Data Card if possible. -->
 
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
+Test split of the same dataset.
 
 #### Metrics
 
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]
+We are using perplexity and BERTScore.
 
 ### Results
 
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- 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]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[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]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+Perplexity: 8.8647
 
+BERTScore: 80.76 
 
 ## Training procedure
 
@@ -216,4 +102,4 @@ The following `bitsandbytes` quantization config was used during training:
 ### Framework versions
 
 
-- PEFT 0.6.0.dev0
+- PEFT 0.6.0.dev0