Laurent1
/

Mistral-7B-Instruct-v0.1-QLoRa-medical-QA

PEFT

Model card Files Files and versions Community

Laurent1 commited on Nov 6, 2023

Commit

4656c68

1 Parent(s): af67cc0

Update README.md

Browse files

Files changed (1) hide show

README.md +37 -181

README.md CHANGED Viewed

@@ -3,205 +3,61 @@ library_name: peft
 base_model: mistralai/Mistral-7B-Instruct-v0.1
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## 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]
-## 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
-<!-- 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]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[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.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
 ### Training Data
-<!-- 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. -->
-#### 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
-<!-- This section describes the evaluation protocols and provides the results. -->
-### 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]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### 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]
-## Training procedure
-### Framework versions
-- PEFT 0.6.0

 base_model: mistralai/Mistral-7B-Instruct-v0.1
 ---
+# Model Card for Mistral-7B-Instruct-v0.1-QLoRa-medical-QA
+![image/gif](https://cdn-uploads.huggingface.co/production/uploads/6489e1e3eb763749c663f40c/PUBFPpFxsrWRlkYzh7lwX.gif)
+<font color="FF0000" size="5"> <b>
+This is a QA model for answering medical questions<br /> </b></font>
+<br><b>Foundation Model : https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.1 <br />
+Dataset :  https://huggingface.co/datasets/Laurent1/MedQuad-MedicalQnADataset_128tokens_max <br /></b>
+The model has been fine tuned with 2 x GPU T4 (RAM : 2 x 14.8GB) + CPU (RAM : 29GB). <br />
+## <b>Model Details</b>
+The model is based upon the foundation model : Mistral-7B-Instruct-v0.1.<br />
+It has been tuned with Supervised Fine-tuning Trainer and PEFT LoRa.<br />
+### Librairies
+<ul>
+<li>bitsandbytes</li>
+<li>einops</li>
+<li>peft</li>
+<li>trl</li>
+<li>datasets</li>
+<li>transformers</li>
+<li>torch</li>
+</ul>
+## <b>Bias, Risks, and Limitations</b>
+In order to reduce training duration, the model has been trained only with the first 5100 rows of the dataset.<br />
+<font color="FF0000">
+Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model.<br />
+Generation of plausible yet incorrect factual information, termed hallucination, is an unsolved issue in large language models.<br />
+</font>
+## <b>Training Details</b>
+<ul>
+<li>per_device_train_batch_size = 1</li>
+<li>gradient_accumulation_steps = 16</li>
+<li>epoch = 5</li>
+<li>2 x GPU T4 (RAM : 14.8GB) + CPU (RAM : 29GB)</li>
+</ul>
 ### Training Data
+https://huggingface.co/datasets/Laurent1/MedQuad-MedicalQnADataset_128tokens_max
 #### Training Hyperparameters
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6489e1e3eb763749c663f40c/C6XTGVrn4D1Sj2kc9Dq2O.png)
+#### Times
+Training duration : 6287.4s