ZappY-AI
/

MASHQA-finetuned-Mistral-7B-Instruct

@@ -1,201 +1,218 @@
 ---
-library_name: transformers
-tags: []
 ---
-# 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. -->
-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]
-### 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 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]
-### 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 Dataset 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]

 ---
+license: apache-2.0
+language:
+- en
+pipeline_tag: text-generation
+tags:
+- pytorch
+- mistral
+- Gen-AI
+- health-QnA
+- medical
 ---
+# MASHQA-Mistral-7B-Instruct
 ### Model Description
+MASHQA-Mistral-7B-Instruct is a large language model fine-tuned on healthcare question-answer pairs to respond safely to the users' queries. It is based on the Mistral-7B Instruct Architecture.
+- Model creator: [Garima Sohi](https://huggingface.co/sohi-g/MASHQA-Mistral-7B-Instruct)
+- Original model: [Mistral-7B-Instruct](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.1)
+### Dataset Description
+- Data Source: [MASHQA (Multiple Answer Spans Healthcare Question Answering) Data](https://drive.google.com/file/d/1ism3N3kMapliaORZQaQU8obNycF8rH9p/view)
+- Data Description: Multiple question-answer pairs in JSON format.
+## Prompt template
+```
+[INST]Act as a Multiple Answer Spans Healthcare Question Answering helpful assistant and answer the user's questions in details with reasoning. Do not give any false information. In case you don't have answer, specify why the question can't be answered.
+### Question:
+{question}
+### Answer:
+```
+## Basics
+*This section provides information about the model type, version, license, funders, release date, developers, and contact information.*
+*It is useful for anyone who wants to reference the model.*
+**Developed by:**  [Garima Sohi](https://huggingface.co/sohi-g)
+**Model Type:** Transformer-based Large Language Model
+**Version:** 1.0.0
+**Languages:** English
+**License:** Apache 2.0
+**Send Questions to:** garimasohi007@gmail.com
+## Technical Specifications
+*This section includes details about the model objective and architecture, and the compute infrastructure.*
+*It is useful for people interested in model development.*
+### Model Architecture and Objective
+* Modified from Mistral-7B-Instruct
+**Objective:** Safely respond to users' health-related queries.
+### Hardware and Software - Compute Infrastructure
+* 4 NVIDIA L4 GPUs & 48 vCPUs
+* Environment: PyTorch (pytorch-2.0 w/ CUDA-11.8; see [Github link](https://github.com/pytorch/pytorch))
+* CPU: GCP G2 Standard 48 (Platform: Intel Cascade Lake) (Accelerator Optimized)
+* CPU memory: 192GB RAM
+* GPU memory: 30GB per GPU
+## Training
+*This section provides information about the training.*
+*It is useful for people who want to learn more about the model inputs and training footprint.*
+The following bits and bytes quantization config was used during training:
+* quant_method: bitsandbytes
+* load_in_8bit: False
+* load_in_4bit: True
+* llm_int8_threshold: 6.0
+* llm_int8_skip_modules: None
+* llm_int8_enable_fp32_cpu_offload: False
+* llm_int8_has_fp16_weight: False
+* bnb_4bit_quant_type: nf4
+* bnb_4bit_use_double_quant: True
+* bnb_4bit_compute_dtype: float16
+Framework versions
+* PEFT 0.4.0
+## How to use
+This model can be easily used and deployed using HuggingFace's ecosystem. This needs `transformers` and `accelerate` installed. The model can be downloaded as follows:
+[MASHQA-Mistral-7B-Instruct](https://huggingface.co/sohi-g/MASHQA-Mistral-7B-Instruct)
+## Intended Use
+This model is being created in order to enable public research on large language models (LLMs). LLMs are intended to be used for language generation or as a pre-trained base model that can be further fine-tuned for specific tasks. The use cases below are not exhaustive.
+### Direct Use
+-   Text generation
+-   Exploring characteristics of language generated by a language model
+    -   Examples: Cloze tests, counterfactuals, generations with reframings
+### Downstream Use
+-   Tasks that leverage language models include: Information Extraction, Question Answering, Summarization
+#### Out-of-scope Uses
+Using the model in [high-stakes](#high-stakes) settings is out of scope for this model.  The model is not designed for [critical decisions](#critical-decisions) nor uses with any material consequences on an individual's livelihood or wellbeing. The model outputs content that appears factual but may not be correct.
+Out-of-scope Uses Include:
+-   Usage for evaluating or scoring individuals, such as for employment, education, or credit
+-   Applying the model for critical automatic decisions, generating factual content, creating reliable summaries, or generating predictions that must be correct
+#### Misuse
+Intentionally using the model for harm, violating [human rights](#human-rights), or other kinds of malicious activities, is a misuse of this model. This includes:
+-   Spam generation
+-   Disinformation and influence operations
+-   Disparagement and defamation
+-   Harassment and abuse
+-   [Deception](#deception)
+-   Unconsented impersonation and imitation
+-   Unconsented surveillance
+-   Generating content without attribution to the model, as specified in the [RAIL License, Use Restrictions](https://huggingface.co/spaces/bigscience/license)
+## Intended Users
+### Direct Users
+-   General Public
+-   Researchers
+-   Students
+-   Educators
+-   Engineers/developers
+-   Non-commercial entities
+-   Health Industry
+# Risks and Limitations
+*This section identifies foreseeable harms and misunderstandings.*
+Model may:
+-   Overrepresent some viewpoints and underrepresent others
+-   Contain stereotypes
+-   Contain [personal information](#personal-data-and-information)
+-   Generate:
+    -   Hateful, abusive, or violent language
+    -   Discriminatory or prejudicial language
+    -   Content that may not be appropriate for all settings, including sexual content
+-   Make errors, including producing incorrect information as if it were factual
+-   Generate irrelevant or repetitive outputs
+-   Induce users into attributing human traits to it, such as sentience or consciousness
+# Evaluation
+*This section describes the evaluation protocols and provides the results.*
+**Train-time Evaluation:**
+Final checkpoint after 500 epochs:
+- Training Loss: 1.216
+# Recommendations
+*This section provides information on warnings and potential mitigations.*
+-   Indirect users should be made aware when the content they're working with is created by the LLM.
+-   Users should be aware of [Risks and Limitations](#risks-and-limitations), and include an appropriate age disclaimer or blocking interface as necessary.
+-   Users of the model should provide mechanisms for those affected to provide feedback, such as an email address for comments.
+# Model Card Authors
+Garima Sohi