Upload README.md

README.md

@@ -0,0 +1,669 @@
+---
+base_model: epfl-llm/meditron-70b
+datasets:
+- bigbio/med_qa
+- medmcqa
+- bigbio/pubmed_qa
+- epfl-llm/guidelines
+inference: false
+language:
+- en
+license: llama2
+metrics:
+- accuracy
+- perplexity
+model_creator: EPFL LLM Team
+model_name: Meditron 70B
+model_type: llama
+pipeline_tag: text-generation
+prompt_template: '<|im_start|>system
+
+  {system_message}<|im_end|>
+
+  <|im_start|>user
+
+  {prompt}<|im_end|>
+
+  <|im_start|>assistant
+
+  '
+quantized_by: TheBloke
+tags:
+- medical
+- health
+- llama2
+---
+<!-- markdownlint-disable MD041 -->
+
+<!-- header start -->
+<!-- 200823 -->
+<div style="width: auto; margin-left: auto; margin-right: auto">
+<img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
+</div>
+<div style="display: flex; justify-content: space-between; width: 100%;">
+    <div style="display: flex; flex-direction: column; align-items: flex-start;">
+        <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
+    </div>
+    <div style="display: flex; flex-direction: column; align-items: flex-end;">
+        <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
+    </div>
+</div>
+<div style="text-align:center; margin-top: 0em; margin-bottom: 0em"><p style="margin-top: 0.25em; margin-bottom: 0em;">TheBloke's LLM work is generously supported by a grant from <a href="https://a16z.com">andreessen horowitz (a16z)</a></p></div>
+<hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
+<!-- header end -->
+
+# Meditron 70B - GPTQ
+- Model creator: [EPFL LLM Team](https://huggingface.co/epfl-llm)
+- Original model: [Meditron 70B](https://huggingface.co/epfl-llm/meditron-70b)
+
+<!-- description start -->
+# Description
+
+This repo contains GPTQ model files for [EPFL LLM Team's Meditron 70B](https://huggingface.co/epfl-llm/meditron-70b).
+
+Multiple GPTQ parameter permutations are provided; see Provided Files below for details of the options provided, their parameters, and the software used to create them.
+
+These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
+
+<!-- description end -->
+<!-- repositories-available start -->
+## Repositories available
+
+* [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/meditron-70B-AWQ)
+* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/meditron-70B-GPTQ)
+* [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/meditron-70B-GGUF)
+* [EPFL LLM Team's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/epfl-llm/meditron-70b)
+<!-- repositories-available end -->
+
+<!-- prompt-template start -->
+## Prompt template: ChatML
+
+```
+<|im_start|>system
+{system_message}<|im_end|>
+<|im_start|>user
+{prompt}<|im_end|>
+<|im_start|>assistant
+
+```
+
+<!-- prompt-template end -->
+
+
+
+<!-- README_GPTQ.md-compatible clients start -->
+## Known compatible clients / servers
+
+These GPTQ models are known to work in the following inference servers/webuis.
+
+- [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
+- [KoboldAI United](https://github.com/henk717/koboldai)
+- [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui)
+- [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
+
+This may not be a complete list; if you know of others, please let me know!
+<!-- README_GPTQ.md-compatible clients end -->
+
+<!-- README_GPTQ.md-provided-files start -->
+## Provided files, and GPTQ parameters
+
+Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
+
+Each separate quant is in a different branch.  See below for instructions on fetching from different branches.
+
+Most GPTQ files are made with AutoGPTQ. Mistral models are currently made with Transformers.
+
+<details>
+  <summary>Explanation of GPTQ parameters</summary>
+
+- Bits: The bit size of the quantised model.
+- GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
+- Act Order: True or False. Also known as `desc_act`. True results in better quantisation accuracy. Some GPTQ clients have had issues with models that use Act Order plus Group Size, but this is generally resolved now.
+- Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
+- GPTQ dataset: The calibration dataset used during quantisation. Using a dataset more appropriate to the model's training can improve quantisation accuracy. Note that the GPTQ calibration dataset is not the same as the dataset used to train the model - please refer to the original model repo for details of the training dataset(s).
+- Sequence Length: The length of the dataset sequences used for quantisation. Ideally this is the same as the model sequence length. For some very long sequence models (16+K), a lower sequence length may have to be used. Note that a lower sequence length does not limit the sequence length of the quantised model. It only impacts the quantisation accuracy on longer inference sequences.
+- ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama and Mistral models in 4-bit.
+
+</details>
+
+| Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
+| ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
+| [main](https://huggingface.co/TheBloke/meditron-70B-GPTQ/tree/main) | 4 | None | Yes | 0.1 | [Medical Medaow WikiDoc](https://huggingface.co/datasets/medalpaca/medical_meadow_wikidoc/viewer/) | 4096 | 35.33 GB | Yes | 4-bit, with Act Order. No group size, to lower VRAM requirements. | 
+| [gptq-4bit-128g-actorder_True](https://huggingface.co/TheBloke/meditron-70B-GPTQ/tree/gptq-4bit-128g-actorder_True) | 4 | 128 | Yes | 0.1 | [Medical Medaow WikiDoc](https://huggingface.co/datasets/medalpaca/medical_meadow_wikidoc/viewer/) | 4096 | 36.65 GB | Yes | 4-bit, with Act Order and group size 128g. Uses even less VRAM than 64g, but with slightly lower accuracy. | 
+| [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/meditron-70B-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [Medical Medaow WikiDoc](https://huggingface.co/datasets/medalpaca/medical_meadow_wikidoc/viewer/) | 4096 | 40.66 GB | Yes | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. | 
+| [gptq-3bit--1g-actorder_True](https://huggingface.co/TheBloke/meditron-70B-GPTQ/tree/gptq-3bit--1g-actorder_True) | 3 | None | Yes | 0.1 | [Medical Medaow WikiDoc](https://huggingface.co/datasets/medalpaca/medical_meadow_wikidoc/viewer/) | 4096 | 26.77 GB | No | 3-bit, with Act Order and no group size. Lowest possible VRAM requirements. May be lower quality than 3-bit 128g. | 
+| [gptq-3bit-128g-actorder_True](https://huggingface.co/TheBloke/meditron-70B-GPTQ/tree/gptq-3bit-128g-actorder_True) | 3 | 128 | Yes | 0.1 | [Medical Medaow WikiDoc](https://huggingface.co/datasets/medalpaca/medical_meadow_wikidoc/viewer/) | 4096 | 28.03 GB | No | 3-bit, with group size 128g and act-order. Higher quality than 128g-False. | 
+| [gptq-3bit-32g-actorder_True](https://huggingface.co/TheBloke/meditron-70B-GPTQ/tree/gptq-3bit-32g-actorder_True) | 3 | 32 | Yes | 0.1 | [Medical Medaow WikiDoc](https://huggingface.co/datasets/medalpaca/medical_meadow_wikidoc/viewer/) | 4096 | 31.84 GB | No | 3-bit, with group size 64g and act-order. Highest quality 3-bit option. |
+
+<!-- README_GPTQ.md-provided-files end -->
+
+<!-- README_GPTQ.md-download-from-branches start -->
+## How to download, including from branches
+
+### In text-generation-webui
+
+To download from the `main` branch, enter `TheBloke/meditron-70B-GPTQ` in the "Download model" box.
+
+To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/meditron-70B-GPTQ:gptq-4bit-128g-actorder_True`
+
+### From the command line
+
+I recommend using the `huggingface-hub` Python library:
+
+```shell
+pip3 install huggingface-hub
+```
+
+To download the `main` branch to a folder called `meditron-70B-GPTQ`:
+
+```shell
+mkdir meditron-70B-GPTQ
+huggingface-cli download TheBloke/meditron-70B-GPTQ --local-dir meditron-70B-GPTQ --local-dir-use-symlinks False
+```
+
+To download from a different branch, add the `--revision` parameter:
+
+```shell
+mkdir meditron-70B-GPTQ
+huggingface-cli download TheBloke/meditron-70B-GPTQ --revision gptq-4bit-128g-actorder_True --local-dir meditron-70B-GPTQ --local-dir-use-symlinks False
+```
+
+<details>
+  <summary>More advanced huggingface-cli download usage</summary>
+
+If you remove the `--local-dir-use-symlinks False` parameter, the files will instead be stored in the central Hugging Face cache directory (default location on Linux is: `~/.cache/huggingface`), and symlinks will be added to the specified `--local-dir`, pointing to their real location in the cache. This allows for interrupted downloads to be resumed, and allows you to quickly clone the repo to multiple places on disk without triggering a download again. The downside, and the reason why I don't list that as the default option, is that the files are then hidden away in a cache folder and it's harder to know where your disk space is being used, and to clear it up if/when you want to remove a download model.
+
+The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
+
+For more documentation on downloading with `huggingface-cli`, please see: [HF -> Hub Python Library -> Download files -> Download from the CLI](https://huggingface.co/docs/huggingface_hub/guides/download#download-from-the-cli).
+
+To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
+
+```shell
+pip3 install hf_transfer
+```
+
+And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
+
+```shell
+mkdir meditron-70B-GPTQ
+HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/meditron-70B-GPTQ --local-dir meditron-70B-GPTQ --local-dir-use-symlinks False
+```
+
+Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
+</details>
+
+### With `git` (**not** recommended)
+
+To clone a specific branch with `git`, use a command like this:
+
+```shell
+git clone --single-branch --branch gptq-4bit-128g-actorder_True https://huggingface.co/TheBloke/meditron-70B-GPTQ
+```
+
+Note that using Git with HF repos is strongly discouraged. It will be much slower than using `huggingface-hub`, and will use twice as much disk space as it has to store the model files twice (it stores every byte both in the intended target folder, and again in the `.git` folder as a blob.)
+
+<!-- README_GPTQ.md-download-from-branches end -->
+<!-- README_GPTQ.md-text-generation-webui start -->
+## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
+
+Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
+
+It is strongly recommended to use the text-generation-webui one-click-installers unless you're sure you know how to make a manual install.
+
+1. Click the **Model tab**.
+2. Under **Download custom model or LoRA**, enter `TheBloke/meditron-70B-GPTQ`.
+
+    - To download from a specific branch, enter for example `TheBloke/meditron-70B-GPTQ:gptq-4bit-128g-actorder_True`
+    - see Provided Files above for the list of branches for each option.
+
+3. Click **Download**.
+4. The model will start downloading. Once it's finished it will say "Done".
+5. In the top left, click the refresh icon next to **Model**.
+6. In the **Model** dropdown, choose the model you just downloaded: `meditron-70B-GPTQ`
+7. The model will automatically load, and is now ready for use!
+8. If you want any custom settings, set them and then click **Save settings for this model** followed by **Reload the Model** in the top right.
+
+    - Note that you do not need to and should not set manual GPTQ parameters any more. These are set automatically from the file `quantize_config.json`.
+
+9. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
+
+<!-- README_GPTQ.md-text-generation-webui end -->
+
+<!-- README_GPTQ.md-use-from-tgi start -->
+## Serving this model from Text Generation Inference (TGI)
+
+It's recommended to use TGI version 1.1.0 or later. The official Docker container is: `ghcr.io/huggingface/text-generation-inference:1.1.0`
+
+Example Docker parameters:
+
+```shell
+--model-id TheBloke/meditron-70B-GPTQ --port 3000 --quantize gptq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
+```
+
+Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):
+
+```shell
+pip3 install huggingface-hub
+```
+
+```python
+from huggingface_hub import InferenceClient
+
+endpoint_url = "https://your-endpoint-url-here"
+
+prompt = "Tell me about AI"
+prompt_template=f'''<|im_start|>system
+{system_message}<|im_end|>
+<|im_start|>user
+{prompt}<|im_end|>
+<|im_start|>assistant
+'''
+
+client = InferenceClient(endpoint_url)
+response = client.text_generation(prompt,
+                                  max_new_tokens=128,
+                                  do_sample=True,
+                                  temperature=0.7,
+                                  top_p=0.95,
+                                  top_k=40,
+                                  repetition_penalty=1.1)
+
+print(f"Model output: {response}")
+```
+<!-- README_GPTQ.md-use-from-tgi end -->
+<!-- README_GPTQ.md-use-from-python start -->
+## Python code example: inference from this GPTQ model
+
+### Install the necessary packages
+
+Requires: Transformers 4.33.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
+
+```shell
+pip3 install --upgrade transformers optimum
+# If using PyTorch 2.1 + CUDA 12.x:
+pip3 install --upgrade auto-gptq
+# or, if using PyTorch 2.1 + CUDA 11.x:
+pip3 install --upgrade auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/
+```
+
+If you are using PyTorch 2.0, you will need to install AutoGPTQ from source. Likewise if you have problems with the pre-built wheels, you should try building from source:
+
+```shell
+pip3 uninstall -y auto-gptq
+git clone https://github.com/PanQiWei/AutoGPTQ
+cd AutoGPTQ
+git checkout v0.5.1
+pip3 install .
+```
+
+### Example Python code
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
+
+model_name_or_path = "TheBloke/meditron-70B-GPTQ"
+# To use a different branch, change revision
+# For example: revision="gptq-4bit-128g-actorder_True"
+model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
+                                             device_map="auto",
+                                             trust_remote_code=False,
+                                             revision="main")
+
+tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
+
+prompt = "Tell me about AI"
+prompt_template=f'''<|im_start|>system
+{system_message}<|im_end|>
+<|im_start|>user
+{prompt}<|im_end|>
+<|im_start|>assistant
+'''
+
+print("\n\n*** Generate:")
+
+input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
+output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
+print(tokenizer.decode(output[0]))
+
+# Inference can also be done using transformers' pipeline
+
+print("*** Pipeline:")
+pipe = pipeline(
+    "text-generation",
+    model=model,
+    tokenizer=tokenizer,
+    max_new_tokens=512,
+    do_sample=True,
+    temperature=0.7,
+    top_p=0.95,
+    top_k=40,
+    repetition_penalty=1.1
+)
+
+print(pipe(prompt_template)[0]['generated_text'])
+```
+<!-- README_GPTQ.md-use-from-python end -->
+
+<!-- README_GPTQ.md-compatibility start -->
+## Compatibility
+
+The files provided are tested to work with Transformers. For non-Mistral models, AutoGPTQ can also be used directly.
+
+[ExLlama](https://github.com/turboderp/exllama) is compatible with Llama and Mistral models in 4-bit. Please see the Provided Files table above for per-file compatibility.
+
+For a list of clients/servers, please see "Known compatible clients / servers", above.
+<!-- README_GPTQ.md-compatibility end -->
+
+<!-- footer start -->
+<!-- 200823 -->
+## Discord
+
+For further support, and discussions on these models and AI in general, join us at:
+
+[TheBloke AI's Discord server](https://discord.gg/theblokeai)
+
+## Thanks, and how to contribute
+
+Thanks to the [chirper.ai](https://chirper.ai) team!
+
+Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
+
+I've had a lot of people ask if they can contribute. I enjoy providing models and helping people, and would love to be able to spend even more time doing it, as well as expanding into new projects like fine tuning/training.
+
+If you're able and willing to contribute it will be most gratefully received and will help me to keep providing more models, and to start work on new AI projects.
+
+Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
+
+* Patreon: https://patreon.com/TheBlokeAI
+* Ko-Fi: https://ko-fi.com/TheBlokeAI
+
+**Special thanks to**: Aemon Algiz.
+
+**Patreon special mentions**: Brandon Frisco, LangChain4j, Spiking Neurons AB, transmissions 11, Joseph William Delisle, Nitin Borwankar, Willem Michiel, Michael Dempsey, vamX, Jeffrey Morgan, zynix, jjj, Omer Bin Jawed, Sean Connelly, jinyuan sun, Jeromy Smith, Shadi, Pawan Osman, Chadd, Elijah Stavena, Illia Dulskyi, Sebastain Graf, Stephen Murray, terasurfer, Edmond Seymore, Celu Ramasamy, Mandus, Alex, biorpg, Ajan Kanaga, Clay Pascal, Raven Klaugh, 阿明, K, ya boyyy, usrbinkat, Alicia Loh, John Villwock, ReadyPlayerEmma, Chris Smitley, Cap'n Zoog, fincy, GodLy, S_X, sidney chen, Cory Kujawski, OG, Mano Prime, AzureBlack, Pieter, Kalila, Spencer Kim, Tom X Nguyen, Stanislav Ovsiannikov, Michael Levine, Andrey, Trailburnt, Vadim, Enrico Ros, Talal Aujan, Brandon Phillips, Jack West, Eugene Pentland, Michael Davis, Will Dee, webtim, Jonathan Leane, Alps Aficionado, Rooh Singh, Tiffany J. Kim, theTransient, Luke @flexchar, Elle, Caitlyn Gatomon, Ari Malik, subjectnull, Johann-Peter Hartmann, Trenton Dambrowitz, Imad Khwaja, Asp the Wyvern, Emad Mostaque, Rainer Wilmers, Alexandros Triantafyllidis, Nicholas, Pedro Madruga, SuperWojo, Harry Royden McLaughlin, James Bentley, Olakabola, David Ziegler, Ai Maven, Jeff Scroggin, Nikolai Manek, Deo Leter, Matthew Berman, Fen Risland, Ken Nordquist, Manuel Alberto Morcote, Luke Pendergrass, TL, Fred von Graf, Randy H, Dan Guido, NimbleBox.ai, Vitor Caleffi, Gabriel Tamborski, knownsqashed, Lone Striker, Erik Bjäreholt, John Detwiler, Leonard Tan, Iucharbius
+
+
+Thank you to all my generous patrons and donaters!
+
+And thank you again to a16z for their generous grant.
+
+<!-- footer end -->
+
+# Original model card: EPFL LLM Team's Meditron 70B
+
+
+<img width=50% src="meditron_LOGO.png" alt="Alt text" title="Meditron-logo">
+
+# Model Card for Meditron-70B-v1.0
+
+Meditron is a suite of open-source medical Large Language Models (LLMs).
+Meditron-70B is a 70 billion parameters model adapted to the medical domain from Llama-2-70B through continued pretraining on a comprehensively curated medical corpus, including selected PubMed articles, abstracts, a [new dataset](https://huggingface.co/datasets/epfl-llm/guidelines) of internationally-recognized medical guidelines, and general domain data from [RedPajama-v1](https://huggingface.co/datasets/togethercomputer/RedPajama-Data-1T).
+Meditron-70B, finetuned on relevant training data, outperforms Llama-2-70B, GPT-3.5 (`text-davinci-003`, 8-shot), and Flan-PaLM on multiple medical reasoning tasks.
+
+
+<!--#  Table of Contents
+
+ [Model Card for Meditron 70B](#model-card-for--meditron-70b-v1.0)
+- [Table of Contents](#table-of-contents)
+- [Model Details](#model-details)
+  - [Model Description](#model-description)
+- [Uses](#uses)
+  - [Downstream Use](#downstream-use)
+  - [Out-of-Scope Use](#out-of-scope-use)
+- [Bias, Risks, and Limitations](#bias-risks-and-limitations)
+  - [Recommendations](#recommendations)
+- [Training Details](#training-details)
+  - [Training Data](#training-data)
+  - [Training Procedure](#training-procedure)
+    - [Preprocessing](#preprocessing)
+- [Evaluation](#evaluation)
+  - [Testing Data & Metrics](#testing-data-&-metrics)
+    - [Testing Data](#testing-data)
+    - [Metrics](#metrics)
+  - [Results](#results)
+- [Environmental Impact](#environmental-impact)
+- [Citation](#citation)-->
+
+<details open>
+  <summary><strong>Advisory Notice</strong></summary>
+
+  <blockquote style="padding: 10px; margin: 0 0 10px; border-left: 5px solid #ddd;">
+    While Meditron is designed to encode medical knowledge from sources of high-quality evidence, it is not yet adapted to deliver this knowledge appropriately, safely, or within professional actionable constraints. 
+  We recommend against deploying Meditron in medical applications without extensive use-case alignment, as well as additional testing, specifically including randomized controlled trials in real-world practice settings.
+  </blockquote>
+</details>
+
+## Model Details
+
+- **Developed by:** [EPFL LLM Team](https://huggingface.co/epfl-llm)
+- **Model type:** Causal decoder-only transformer language model
+- **Language(s):** English (mainly)
+- **Model License:** [LLAMA 2 COMMUNITY LICENSE AGREEMENT](https://huggingface.co/meta-llama/Llama-2-70b/raw/main/LICENSE.txt)
+- **Code License:** [APACHE 2.0 LICENSE](LICENSE)
+- **Continue-pretrained from model:** [Llama-2-70B](https://huggingface.co/meta-llama/Llama-2-70b)
+- **Context length:**  4K tokens
+- **Input:**  Text-only data
+- **Output:**  Model generates text only
+- **Status:** This is a static model trained on an offline dataset. Future versions of the tuned models will be released as we enhance model's performance.
+- **Knowledge Cutoff:** August 2023
+
+
+### Model Sources
+
+- **Repository:** [epflLLM/meditron](https://github.com/epfLLM/meditron)
+- **Trainer:** [epflLLM/Megatron-LLM](https://github.com/epfLLM/Megatron-LLM)
+- **Paper:** *[MediTron-70B: Scaling Medical Pretraining for Large Language Models](https://arxiv.org/abs/2311.16079)*
+
+## Uses
+
+Meditron-70B is being made available for further testing and assessment as an AI assistant to enhance clinical decision-making and enhance access to an LLM for healthcare use. Potential use cases may include but are not limited to:
+-  Medical exam question answering
+-  Supporting differential diagnosis
+-  Disease information (symptoms, cause, treatment) query
+-  General health information query
+
+### Direct Use
+
+It is possible to use this model to generate text, which is useful for experimentation and understanding its capabilities. 
+It should not be used directly for production or work that may impact people.
+
+### Downstream Use
+Meditron-70B is a foundation model that can be finetuned, instruction-tuned, or RLHF-tuned for specific downstream tasks and applications.
+The main way we have used this model is finetuning for downstream question-answering tasks, but we encourage using this model for additional applications.
+
+Specific formatting needs to be followed to prompt our finetuned models, including the  `<|im_start|>`, `<|im_end|>` tags, and  `system`, `question`, `answer`  identifiers.
+    
+    """
+    <|im_start|>system
+    {system_message}<|im_end|>
+    <|im_start|>question
+    {prompt}<|im_end|>
+    <|im_start|>answer  
+    """
+
+**Note 1**: The above formatting is not required for running the base model (this repository)
+
+**Note 2**: the above formatting is just an example of a finetuning template. This format is not a requirement if you use your own formatting option for the finetuning of the model.
+
+To run proper generation with this base model, we recommend using a high-throughput and memory-efficient inference engine, such as [vLLM](https://github.com/vllm-project/vllm), with a UI that supports chat and text generation, such as [BetterChatGPT](https://github.com/ztjhz/BetterChatGPT)
+To see more details about model deployment and generation, please see our [documentation](https://github.com/epfLLM/meditron/blob/main/deployment/README.md).
+
+### Out-of-Scope Use
+
+We do not recommend using this model for natural language generation in a production environment, finetuned or otherwise.
+
+## Truthfulness, Helpfulness, Risk, and Bias
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+We did an initial assessment of Meditron models' **Truthfulness** against baseline models and consumer-level medical models. 
+We use TruthfulQA (multiple choice) as the main evaluation benchmark.
+We only focus on the categories that are relevant to the medical domain, including Health, Nutrition, Psychology, and Science.
+For 7B models, we perform one-shot evaluations for consistent answer generation.
+For 70B models, the evaluations are under the zero-shot setting.
+Below, we report the detailed truthfulness performance of each category.
+
+|     |        |      |      |      |      |      |      |
+| --- | ------ |----- |----- |----- |----- |----- |----- |
+|Category  | meditron-70b | llama-2-70b | med42-70b* | meditron-7b | llama-2-7b | PMC-llama-7b |
+|Health    |      81.8    |    69.1     |    83.6    | 27.3        |   16.4     |      3.6     |
+|Nutrition |      77.9    |    68.8     |    62.5    | 31.1        |   12.5     |      6.3     |
+|Psychology|      47.4    |    36.8     |    52.6    | 21.1        |   10.5     |      0.0     |
+|Science   |      77.8    |    44.4     |    33.3    | 33.3        |   11.1     |      0.0     |
+|Avg       |      71.2    |    54.8     |    58.0    | 28.3        |   12.6     |      2.5     |
+|          |              |             |            |             |            |              |
+
+For a more detailed performance analysis, please see our paper. 
+
+For **Helpfulness**, **Risk** and **Bias**, we provide a comprehensive qualitative generation report of Meditron-70B on queries designed by medical experts.
+Each query targets specific aspects of helpfulness (medical accuracy, up-to-date information, etc.), risk (public health, medical ethics, etc.) and bias (gender, age, race, etc.).
+Please see the detailed generations in our paper. We compare our generations to Llama-2-70B and ChatGPT-3.5 (version Nov, 27, 2023)
+
+Significant research is still required to fully explore potential bias, fairness, and safety issues with this language model. 
+
+
+### Recommendations
+
+**IMPORTANT!**
+Users (both direct and downstream) should be made aware of the risks, biases, and limitations of the model.
+While this model is capable of generating natural language text, we have only begun to explore this capability and its limitations. 
+Understanding these limitations is especially important in a domain like medicine. 
+Therefore, we strongly recommend against using this model in production for natural language generation or for professional purposes related to health and medicine without comprehensive testing for your application. 
+
+## Training Details
+
+### Training Data
+Meditron’s domain-adaptive pre-training corpus GAP-Replay  combines 48.1B tokens from four corpora:
+- [**Clinical  Guidelines**](https://huggingface.co/datasets/epfl-llm/guidelines): a new dataset of 46K internationally-recognized clinical practice guidelines from various healthcare-related sources, including hospitals and international organizations. 
+- **Medical Paper Abstracts**: 16.1M abstracts extracted from closed-access PubMed and PubMed Central papers.
+- **Medical Papers**: full-text articles extracted from 5M publicly available PubMed and PubMed Central papers.
+- **Replay Data**: 400M tokens of general domain pretraining data sampled from [RedPajama-v1](https://huggingface.co/datasets/togethercomputer/RedPajama-Data-1T)
+
+
+<img width="60%" src="gap-replay.png" alt="Alt text" title="Meditron-logo">
+
+
+#### Data Preprocessing
+
+Please see the detailed preprocessing procedure in our paper. 
+
+### Training Procedure 
+
+We used the [Megatron-LLM](https://github.com/epfLLM/Megatron-LLM) distributed training library, a derivative of Nvidia's Megatron LM project, to optimize training efficiency. 
+Hardware consists of 16 nodes of 8x NVIDIA A100 (80GB) SXM GPUs connected by NVLink and NVSwitch with a single Nvidia ConnectX-6 DX network card and equipped with 2 x AMD EPYC 7543 32-Core Processors and 512 GB of RAM. 
+The nodes are connected via RDMA over Converged Ethernet.
+
+Our three-way parallelism scheme uses:
+ - Data Parallelism (DP -- different GPUs process different subsets of the batches) of 2,
+ - Pipeline Parallelism (PP -- different GPUs process different layers) of 8,
+ - Tensor Parallelism (TP -- different GPUs process different subtensors for matrix multiplication) of 8.
+   
+
+#### Training Hyperparameters
+
+|  |  |
+| --- | ------ |
+| bf16 | true |
+| lr  | 1.5e-4 |
+| eps | 1e-5       |
+| betas | \[0.9, 0.95\] |
+| clip_grad | 1 |
+| weight decay | 0.1 |
+| DP size | 2 |
+| TP size | 8 |
+| PP size | 8 |
+| seq length | 4096 |
+| lr scheduler | cosine|
+| min lr | 1e-6 |
+| warmup iteration | 2000 |
+| micro batch size | 2 |
+| global batch size | 512 |
+|  |  |
+
+#### Speeds, Sizes, Times
+The model was trained in September and October 2023.
+
+The model architecture is exactly Llama 2, meaning
+
+|     |        | 
+| --- | ------ |
+| Model size           | 70B  | 
+| Hidden dimension     | 8192 |
+| Num. attention heads |   64 |
+| Num. layers          |   80 |
+|  |  | | 
+
+We train the 70B model on 48e9 tokens, at a throughput of about 40,200 tokens / second. 
+This amounts to a bfloat16 model flops utilization of roughly 42.3\%.
+
+## Evaluation
+
+<!-- This section describes the evaluation protocols and provides the results. -->
+
+### Testing Data & Metrics
+
+#### Testing Data
+- [MedQA (USMLE)](https://huggingface.co/datasets/bigbio/med_qa)
+- [MedMCQA](https://huggingface.co/datasets/medmcqa)
+- [PubMedQA](https://huggingface.co/datasets/bigbio/pubmed_qa)
+- [MMLU-Medical](https://huggingface.co/datasets/lukaemon/mmlu)
+- [MedQA-4-Option](https://huggingface.co/datasets/GBaker/MedQA-USMLE-4-options)
+
+#### Metrics
+- Accuracy: suite the evaluation of multiple-choice question-answering tasks.
+
+### Results
+We finetune meditron-70b and llama-2-70b on each benchmark (pubmedqa, medmcqa, medqa)'s training data individually. 
+We report the finetuned models' performance with self-consistency chain-of-thought as the inference mode.
+For MMLU-Medical, models finetuned on MedMCQA are used for inference.
+For MedQA-4-Option, models finetuned on MedQA are used for inference.
+For a more detailed performance analysis, please see our paper. 
+
+|     |        |      |      |      |      |
+| --- | ------ |----- |----- |----- |----- |
+|Dataset|     meditron-70b | llama-2-70b | med42-70b* | clinical-camel-70b* |
+|MMLU-Medical | 77.6       |    77.9     | 74.5      | 65.7               |
+|PubMedQA     | 81.6       |    80.0     | 61.2      | 67.0               |
+|MedMCQA      | 66.0       |    62.6     | 59.2      | 46.7               |
+|MedQA        | 64.4       |    61.5     | 59.1      | 50.8               |
+|MedQA-4-Option| 70.2      |    63.8     | 63.9      | 56.8               |
+|Avg          | 72.0       |    69.2     | 63.6      | 57.4               |
+|     |        |      |      |      |      |
+
+**Note**: models with * are already instruction-tuned, so we exclude them from further finetuning on any training data.
+
+## Environmental Impact
+
+<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
+
+- **Hardware Type:** 128 x NVIDIA A100 (80GB) SXM
+- **Total GPU hours:** 42,496
+- **Hardware Provider:** EPFL Research Computing Platform
+- **Compute Region:** Switzerland
+- **Carbon Emitted:** Switzerland has a carbon efficiency of 0.016 kgCO2/kWh (https://www.carbonfootprint.com/docs/2018_8_electricity_factors_august_2018_-_online_sources.pdf). 332 hours of 128 A100s means 42496 hours at a TDP of 400W. Assuming a Power Usage effectiveness of 1.8, total emissions are estimated to be: 
+    
+   (400W / 1000W/kWh / GPU * 0.016 kgCO2/kWh * 332 h * 128 GPU) * 1.8 PUE = 486 kgCO2.
+
+## Citation
+
+**BibTeX:**
+If you use Meditron or its training data, please cite our work:
+
+```
+@misc{chen2023meditron70b,
+      title={MEDITRON-70B: Scaling Medical Pretraining for Large Language Models}, 
+      author={Zeming Chen and Alejandro Hernández-Cano and Angelika Romanou and Antoine Bonnet and Kyle Matoba and Francesco Salvi and Matteo Pagliardini and Simin Fan and Andreas Köpf and Amirkeivan Mohtashami and Alexandre Sallinen and Alireza Sakhaeirad and Vinitra Swamy and Igor Krawczuk and Deniz Bayazit and Axel Marmet and Syrielle Montariol and Mary-Anne Hartley and Martin Jaggi and Antoine Bosselut},
+      year={2023},
+      eprint={2311.16079},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL}
+}
+
+@software{epfmedtrn,
+  author = {Zeming Chen and Alejandro Hernández Cano and Angelika Romanou and Antoine Bonnet and Kyle Matoba and Francesco Salvi and Matteo Pagliardini and Simin Fan and Andreas Köpf and Amirkeivan Mohtashami and Alexandre Sallinen and Alireza Sakhaeirad and Vinitra Swamy and Igor Krawczuk and Deniz Bayazit and Axel Marmet and Syrielle Montariol and Mary-Anne Hartley and Martin Jaggi and Antoine Bosselut},
+  title = {MediTron-70B: Scaling Medical Pretraining for Large Language Models},
+  month = November,
+  year = 2023,
+  url = {https://github.com/epfLLM/meditron}
+}
+```