Update README.md

README.md

@@ -1,5 +1,13 @@
 ---
+language:
+- en
+pipeline_tag: text-generation
 tags:
+- facebook
+- meta
+- pytorch
+- llama
+- llama-3
 - quantized
 - 2-bit
 - 3-bit
@@ -7,224 +15,614 @@ tags:
 - 5-bit
 - 6-bit
 - 8-bit
+- 16-bit
 - GGUF
-- transformers
-- safetensors
-- llama
-- text-generation
-- facebook
-- meta
-- pytorch
-- llama-3
-- conversational
-- en
-- license:other
-- autotrain_compatible
-- endpoints_compatible
-- has_space
-- text-generation-inference
-- region:us
-- text-generation
-model_name: Meta-Llama-3-8B-Instruct-GGUF
-base_model: meta-llama/Meta-Llama-3-8B-Instruct
 inference: false
-model_creator: meta-llama
-pipeline_tag: text-generation
+model_creator: MaziyarPanahi
+model_name: Meta-Llama-3-8B-Instruct-GGUF
 quantized_by: MaziyarPanahi
+license_name: llama3
 ---
-# [MaziyarPanahi/Meta-Llama-3-8B-Instruct-GGUF](https://huggingface.co/MaziyarPanahi/Meta-Llama-3-8B-Instruct-GGUF)
-- Model creator: [meta-llama](https://huggingface.co/meta-llama)
-- Original model: [meta-llama/Meta-Llama-3-8B-Instruct](https://huggingface.co/meta-llama/Meta-Llama-3-8B-Instruct)
 
-## Description
-[MaziyarPanahi/Meta-Llama-3-8B-Instruct-GGUF](https://huggingface.co/MaziyarPanahi/Meta-Llama-3-8B-Instruct-GGUF) contains GGUF format model files for [meta-llama/Meta-Llama-3-8B-Instruct](https://huggingface.co/meta-llama/Meta-Llama-3-8B-Instruct).
 
-## How to use
-Thanks to [TheBloke](https://huggingface.co/TheBloke) for preparing an amazing README on how to use GGUF models:
+# MaziyarPanahi/Meta-Llama-3-8B-Instruct-GGUF
 
-### About GGUF
+The GGUF and quantized models here are based on [meta-llama/Meta-Llama-3-8B-Instruct](https://huggingface.co/meta-llama/Meta-Llama-3-8B-Instruct) model
 
-GGUF is a new format introduced by the llama.cpp team on August 21st 2023. It is a replacement for GGML, which is no longer supported by llama.cpp.
+## How to download
+You can download only the quants you need instead of cloning the entire repository as follows:
 
-Here is an incomplete list of clients and libraries that are known to support GGUF:
+```
+huggingface-cli download MaziyarPanahi/Meta-Llama-3-8B-Instruct-GGUF --local-dir . --include '*Q2_K*gguf'
+```
 
-* [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
-* [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions. Supports GPU acceleration.
-* [KoboldCpp](https://github.com/LostRuins/koboldcpp), a fully featured web UI, with GPU accel across all platforms and GPU architectures. Especially good for story telling.
-* [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
-* [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration. Linux available, in beta as of 27/11/2023.
-* [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with many interesting and unique features, including a full model library for easy model selection.
-* [Faraday.dev](https://faraday.dev/), an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
-* [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
-* [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
-* [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server. Note, as of time of writing (November 27th 2023), ctransformers has not been updated in a long time and does not support many recent models.
+## Load GGUF models
 
-### Explanation of quantisation methods
 
-<details>
-  <summary>Click to see details</summary>
+```sh
+llama.cpp/main -m Meta-Llama-3-8B-Instruct.Q2_K.gguf -p "Building a website can be done in 10 simple steps:\nStep 1:" -n 1024 -e
+```
 
-The new methods available are:
 
-* GGML_TYPE_Q2_K - "type-1" 2-bit quantization in super-blocks containing 16 blocks, each block having 16 weight. Block scales and mins are quantized with 4 bits. This ends up effectively using 2.5625 bits per weight (bpw)
-* GGML_TYPE_Q3_K - "type-0" 3-bit quantization in super-blocks containing 16 blocks, each block having 16 weights. Scales are quantized with 6 bits. This end up using 3.4375 bpw.
-* GGML_TYPE_Q4_K - "type-1" 4-bit quantization in super-blocks containing 8 blocks, each block having 32 weights. Scales and mins are quantized with 6 bits. This ends up using 4.5 bpw.
-* GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
-* GGML_TYPE_Q6_K - "type-0" 6-bit quantization. Super-blocks with 16 blocks, each block having 16 weights. Scales are quantized with 8 bits. This ends up using 6.5625 bpw
 
-## How to download GGUF files
 
-**Note for manual downloaders:** You almost never want to clone the entire repo! Multiple different quantisation formats are provided, and most users only want to pick and download a single file.
+Original README
 
-The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
+---
 
-* LM Studio
-* LoLLMS Web UI
-* Faraday.dev
+## Model Details
 
-### In `text-generation-webui`
+Meta developed and released the Meta Llama 3 family of large language models (LLMs), a collection of pretrained and instruction tuned generative text models in 8 and 70B sizes. The Llama 3 instruction tuned models are optimized for dialogue use cases and outperform many of the available open source chat models on common industry benchmarks. Further, in developing these models, we took great care to optimize helpfulness and safety. 
 
-Under Download Model, you can enter the model repo: [MaziyarPanahi/Meta-Llama-3-8B-Instruct-GGUF](https://huggingface.co/MaziyarPanahi/Meta-Llama-3-8B-Instruct-GGUF) and below it, a specific filename to download, such as: Meta-Llama-3-8B-Instruct-GGUF.Q4_K_M.gguf.
+**Model developers** Meta
 
-Then click Download.
+**Variations** Llama 3 comes in two sizes — 8B and 70B parameters — in pre-trained and instruction tuned variants.
 
-### On the command line, including multiple files at once
+**Input** Models input text only.
 
-I recommend using the `huggingface-hub` Python library:
+**Output** Models generate text and code only.
 
-```shell
-pip3 install huggingface-hub
-```
+**Model Architecture** Llama 3 is an auto-regressive language model that uses an optimized transformer architecture. The tuned versions use supervised fine-tuning (SFT) and reinforcement learning with human feedback (RLHF) to align with human preferences for helpfulness and safety.
 
-Then you can download any individual model file to the current directory, at high speed, with a command like this:
 
-```shell
-huggingface-cli download MaziyarPanahi/Meta-Llama-3-8B-Instruct-GGUF Meta-Llama-3-8B-Instruct.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
-```
-</details>
-<details>
-  <summary>More advanced huggingface-cli download usage (click to read)</summary>
+<table>
+  <tr>
+   <td>
+   </td>
+   <td><strong>Training Data</strong>
+   </td>
+   <td><strong>Params</strong>
+   </td>
+   <td><strong>Context length</strong>
+   </td>
+   <td><strong>GQA</strong>
+   </td>
+   <td><strong>Token count</strong>
+   </td>
+   <td><strong>Knowledge cutoff</strong>
+   </td>
+  </tr>
+  <tr>
+   <td rowspan="2" >Llama 3
+   </td>
+   <td rowspan="2" >A new mix of publicly available online data.
+   </td>
+   <td>8B
+   </td>
+   <td>8k
+   </td>
+   <td>Yes
+   </td>
+   <td rowspan="2" >15T+
+   </td>
+   <td>March, 2023
+   </td>
+  </tr>
+  <tr>
+   <td>70B
+   </td>
+   <td>8k
+   </td>
+   <td>Yes
+   </td>
+   <td>December, 2023
+   </td>
+  </tr>
+</table>
 
-You can also download multiple files at once with a pattern:
 
-```shell
-huggingface-cli download [MaziyarPanahi/Meta-Llama-3-8B-Instruct-GGUF](https://huggingface.co/MaziyarPanahi/Meta-Llama-3-8B-Instruct-GGUF) --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
-```
+**Llama 3 family of models**. Token counts refer to pretraining data only. Both the 8 and 70B versions use Grouped-Query Attention (GQA) for improved inference scalability.
 
-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).
+**Model Release Date** April 18, 2024.
 
-To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
+**Status** This is a static model trained on an offline dataset. Future versions of the tuned models will be released as we improve model safety with community feedback.
 
-```shell
-pip3 install hf_transfer
-```
+**License** A custom commercial license is available at: [https://llama.meta.com/llama3/license](https://llama.meta.com/llama3/license)
+
+Where to send questions or comments about the model Instructions on how to provide feedback or comments on the model can be found in the model [README](https://github.com/meta-llama/llama3). For more technical information about generation parameters and recipes for how to use Llama 3 in applications, please go [here](https://github.com/meta-llama/llama-recipes). 
+
+
+## Intended Use
+
+**Intended Use Cases** Llama 3 is intended for commercial and research use in English. Instruction tuned models are intended for assistant-like chat, whereas pretrained models can be adapted for a variety of natural language generation tasks.
+
+**Out-of-scope** Use in any manner that violates applicable laws or regulations (including trade compliance laws). Use in any other way that is prohibited by the Acceptable Use Policy and Llama 3 Community License. Use in languages other than English**.
+
+**Note: Developers may fine-tune Llama 3 models for languages beyond English provided they comply with the Llama 3 Community License and the Acceptable Use Policy.
+
+## How to use
 
-And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
+This repository contains two versions of Meta-Llama-3-70B-Instruct, for use with transformers and with the original `llama3` codebase.
+
+### Use with transformers
+
+See the snippet below for usage with Transformers:
+
+```python
+import transformers
+import torch
+
+model_id = "meta-llama/Meta-Llama-3-70B-Instruct"
+
+pipeline = transformers.pipeline(
+    "text-generation",
+    model=model_id,
+    model_kwargs={"torch_dtype": torch.bfloat16},
+    device="cuda",
+)
+
+messages = [
+    {"role": "system", "content": "You are a pirate chatbot who always responds in pirate speak!"},
+    {"role": "user", "content": "Who are you?"},
+]
+
+prompt = pipeline.tokenizer.apply_chat_template(
+		messages, 
+		tokenize=False, 
+		add_generation_prompt=True
+)
 
-```shell
-HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download MaziyarPanahi/Meta-Llama-3-8B-Instruct-GGUF Meta-Llama-3-8B-Instruct.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
+terminators = [
+    tokenizer.eos_token_id,
+    tokenizer.convert_tokens_to_ids("<|eot_id|>")
+]
+
+outputs = pipeline(
+    prompt,
+    max_new_tokens=256,
+    eos_token_id=terminators,
+    do_sample=True,
+    temperature=0.6,
+    top_p=0.9,
+)
+print(outputs[0]["generated_text"][len(prompt):])
 ```
 
-Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
-</details>
+### Use with `llama3`
 
-## Example `llama.cpp` command
+Please, follow the instructions in the [repository](https://github.com/meta-llama/llama3).
 
-Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
+To download Original checkpoints, see the example command below leveraging `huggingface-cli`:
 
-```shell
-./main -ngl 35 -m Meta-Llama-3-8B-Instruct.Q4_K_M.gguf --color -c 32768 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "<|im_start|>system
-{system_message}<|im_end|>
-<|im_start|>user
-{prompt}<|im_end|>
-<|im_start|>assistant"
+```
+huggingface-cli download meta-llama/Meta-Llama-3-70B-Instruct --include "original/*" --local-dir Meta-Llama-3-70B-Instruct
 ```
 
-Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
+For Hugging Face support, we recommend using transformers or TGI, but a similar command works.
+
+## Hardware and Software
+
+**Training Factors** We used custom training libraries, Meta's Research SuperCluster, and production clusters for pretraining. Fine-tuning, annotation, and evaluation were also performed on third-party cloud compute.
+
+**Carbon Footprint Pretraining utilized a cumulative** 7.7M GPU hours of computation on hardware of type H100-80GB (TDP of 700W). Estimated total emissions were 2290 tCO2eq, 100% of which were offset by Meta’s sustainability program.
+
+
+<table>
+  <tr>
+   <td>
+   </td>
+   <td><strong>Time (GPU hours)</strong>
+   </td>
+   <td><strong>Power Consumption (W)</strong>
+   </td>
+   <td><strong>Carbon Emitted(tCO2eq)</strong>
+   </td>
+  </tr>
+  <tr>
+   <td>Llama 3 8B
+   </td>
+   <td>1.3M
+   </td>
+   <td>700
+   </td>
+   <td>390
+   </td>
+  </tr>
+  <tr>
+   <td>Llama 3 70B
+   </td>
+   <td>6.4M
+   </td>
+   <td>700
+   </td>
+   <td>1900
+   </td>
+  </tr>
+  <tr>
+   <td>Total
+   </td>
+   <td>7.7M
+   </td>
+   <td>
+   </td>
+   <td>2290
+   </td>
+  </tr>
+</table>
+
+
+
+**CO2 emissions during pre-training**. Time: total GPU time required for training each model. Power Consumption: peak power capacity per GPU device for the GPUs used adjusted for power usage efficiency. 100% of the emissions are directly offset by Meta's sustainability program, and because we are openly releasing these models, the pretraining costs do not need to be incurred by others.
+
+
+## Training Data
+
+**Overview** Llama 3 was pretrained on over 15 trillion tokens of data from publicly available sources. The fine-tuning data includes publicly available instruction datasets, as well as over 10M human-annotated examples. Neither the pretraining nor the fine-tuning datasets include Meta user data.
+
+**Data Freshness** The pretraining data has a cutoff of March 2023 for the 7B and December 2023 for the 70B models respectively. 
+
+
+## Benchmarks 
+
+In this section, we report the results for Llama 3 models on standard automatic benchmarks. For all the evaluations, we use our internal evaluations library. For details on the methodology see [here](https://github.com/meta-llama/llama3/blob/main/eval_methodology.md).
+
+
+### Base pretrained models
+
+
+<table>
+  <tr>
+   <td><strong>Category</strong>
+   </td>
+   <td><strong>Benchmark</strong>
+   </td>
+   <td><strong>Llama 3 8B</strong>
+   </td>
+   <td><strong>Llama2 7B</strong>
+   </td>
+   <td><strong>Llama2 13B</strong>
+   </td>
+   <td><strong>Llama 3 70B</strong>
+   </td>
+   <td><strong>Llama2 70B</strong>
+   </td>
+  </tr>
+  <tr>
+   <td rowspan="6" >General
+   </td>
+   <td>MMLU (5-shot)
+   </td>
+   <td>66.6
+   </td>
+   <td>45.7
+   </td>
+   <td>53.8
+   </td>
+   <td>79.5
+   </td>
+   <td>69.7
+   </td>
+  </tr>
+  <tr>
+   <td>AGIEval English (3-5 shot)
+   </td>
+   <td>45.9
+   </td>
+   <td>28.8
+   </td>
+   <td>38.7
+   </td>
+   <td>63.0
+   </td>
+   <td>54.8
+   </td>
+  </tr>
+  <tr>
+   <td>CommonSenseQA (7-shot)
+   </td>
+   <td>72.6
+   </td>
+   <td>57.6
+   </td>
+   <td>67.6
+   </td>
+   <td>83.8
+   </td>
+   <td>78.7
+   </td>
+  </tr>
+  <tr>
+   <td>Winogrande (5-shot)
+   </td>
+   <td>76.1
+   </td>
+   <td>73.3
+   </td>
+   <td>75.4
+   </td>
+   <td>83.1
+   </td>
+   <td>81.8
+   </td>
+  </tr>
+  <tr>
+   <td>BIG-Bench Hard (3-shot, CoT)
+   </td>
+   <td>61.1
+   </td>
+   <td>38.1
+   </td>
+   <td>47.0
+   </td>
+   <td>81.3
+   </td>
+   <td>65.7
+   </td>
+  </tr>
+  <tr>
+   <td>ARC-Challenge (25-shot)
+   </td>
+   <td>78.6
+   </td>
+   <td>53.7
+   </td>
+   <td>67.6
+   </td>
+   <td>93.0
+   </td>
+   <td>85.3
+   </td>
+  </tr>
+  <tr>
+   <td>Knowledge reasoning
+   </td>
+   <td>TriviaQA-Wiki (5-shot)
+   </td>
+   <td>78.5
+   </td>
+   <td>72.1
+   </td>
+   <td>79.6
+   </td>
+   <td>89.7
+   </td>
+   <td>87.5
+   </td>
+  </tr>
+  <tr>
+   <td rowspan="4" >Reading comprehension
+   </td>
+   <td>SQuAD (1-shot)
+   </td>
+   <td>76.4
+   </td>
+   <td>72.2
+   </td>
+   <td>72.1
+   </td>
+   <td>85.6
+   </td>
+   <td>82.6
+   </td>
+  </tr>
+  <tr>
+   <td>QuAC (1-shot, F1)
+   </td>
+   <td>44.4
+   </td>
+   <td>39.6
+   </td>
+   <td>44.9
+   </td>
+   <td>51.1
+   </td>
+   <td>49.4
+   </td>
+  </tr>
+  <tr>
+   <td>BoolQ (0-shot)
+   </td>
+   <td>75.7
+   </td>
+   <td>65.5
+   </td>
+   <td>66.9
+   </td>
+   <td>79.0
+   </td>
+   <td>73.1
+   </td>
+  </tr>
+  <tr>
+   <td>DROP (3-shot, F1)
+   </td>
+   <td>58.4
+   </td>
+   <td>37.9
+   </td>
+   <td>49.8
+   </td>
+   <td>79.7
+   </td>
+   <td>70.2
+   </td>
+  </tr>
+</table>
+
+
+
+### Instruction tuned models
+
+
+<table>
+  <tr>
+   <td><strong>Benchmark</strong>
+   </td>
+   <td><strong>Llama 3 8B</strong>
+   </td>
+   <td><strong>Llama 2 7B</strong>
+   </td>
+   <td><strong>Llama 2 13B</strong>
+   </td>
+   <td><strong>Llama 3 70B</strong>
+   </td>
+   <td><strong>Llama 2 70B</strong>
+   </td>
+  </tr>
+  <tr>
+   <td>MMLU (5-shot)
+   </td>
+   <td>68.4
+   </td>
+   <td>34.1
+   </td>
+   <td>47.8
+   </td>
+   <td>82.0
+   </td>
+   <td>52.9
+   </td>
+  </tr>
+  <tr>
+   <td>GPQA (0-shot)
+   </td>
+   <td>34.2
+   </td>
+   <td>21.7
+   </td>
+   <td>22.3
+   </td>
+   <td>39.5
+   </td>
+   <td>21.0
+   </td>
+  </tr>
+  <tr>
+   <td>HumanEval (0-shot)
+   </td>
+   <td>62.2
+   </td>
+   <td>7.9
+   </td>
+   <td>14.0
+   </td>
+   <td>81.7
+   </td>
+   <td>25.6
+   </td>
+  </tr>
+  <tr>
+   <td>GSM-8K (8-shot, CoT)
+   </td>
+   <td>79.6
+   </td>
+   <td>25.7
+   </td>
+   <td>77.4
+   </td>
+   <td>93.0
+   </td>
+   <td>57.5
+   </td>
+  </tr>
+  <tr>
+   <td>MATH (4-shot, CoT)
+   </td>
+   <td>30.0
+   </td>
+   <td>3.8
+   </td>
+   <td>6.7
+   </td>
+   <td>50.4
+   </td>
+   <td>11.6
+   </td>
+  </tr>
+</table>
 
-Change `-c 32768` to the desired sequence length. For extended sequence models - eg 8K, 16K, 32K - the necessary RoPE scaling parameters are read from the GGUF file and set by llama.cpp automatically. Note that longer sequence lengths require much more resources, so you may need to reduce this value.
 
-If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
 
-For other parameters and how to use them, please refer to [the llama.cpp documentation](https://github.com/ggerganov/llama.cpp/blob/master/examples/main/README.md)
+### Responsibility & Safety
 
-## How to run in `text-generation-webui`
+We believe that an open approach to AI leads to better, safer products, faster innovation, and a bigger overall market. We are committed to Responsible AI development and took a series of steps to limit misuse and harm and support the open source community.
 
-Further instructions can be found in the text-generation-webui documentation, here: [text-generation-webui/docs/04 ‐ Model Tab.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/04%20-%20Model%20Tab.md#llamacpp).
+Foundation models are widely capable technologies that are built to be used for a diverse range of applications. They are not designed to meet every developer preference on safety levels for all use cases, out-of-the-box, as those by their nature will differ across different applications. 
 
-## How to run from Python code
+Rather, responsible LLM-application deployment is achieved by implementing a series of safety best practices throughout the development of such applications, from the model pre-training, fine-tuning and the deployment of systems composed of safeguards to tailor the safety needs specifically to the use case and audience. 
 
-You can use GGUF models from Python using the [llama-cpp-python](https://github.com/abetlen/llama-cpp-python) or [ctransformers](https://github.com/marella/ctransformers) libraries. Note that at the time of writing (Nov 27th 2023), ctransformers has not been updated for some time and is not compatible with some recent models. Therefore I recommend you use llama-cpp-python.
 
-### How to load this model in Python code, using llama-cpp-python
+As part of the Llama 3 release, we updated our [Responsible Use Guide](https://llama.meta.com/responsible-use-guide/) to outline the steps and best practices for developers to implement model and system level safety for their application. We also provide a set of resources including [Meta Llama Guard 2](https://llama.meta.com/purple-llama/) and [Code Shield](https://llama.meta.com/purple-llama/) safeguards. These tools have proven to drastically reduce residual risks of LLM Systems, while maintaining a high level of helpfulness. We encourage developers to tune and deploy these safeguards according to their needs and we provide a [reference implementation](https://github.com/meta-llama/llama-recipes/tree/main/recipes/responsible_ai) to get you started.
 
-For full documentation, please see: [llama-cpp-python docs](https://github.com/abetlen/llama-cpp-python/).
 
-#### First install the package
+#### Llama 3-Instruct
 
-Run one of the following commands, according to your system:
+As outlined in the Responsible Use Guide, some trade-off between model helpfulness and model alignment is likely unavoidable. Developers should exercise discretion about how to weigh the benefits of alignment and helpfulness for their specific use case and audience. Developers should be mindful of residual risks when using Llama models and leverage additional safety tools as needed to reach the right safety bar for their use case. 
 
-```shell
-# Base ctransformers with no GPU acceleration
-pip install llama-cpp-python
-# With NVidia CUDA acceleration
-CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
-# Or with OpenBLAS acceleration
-CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
-# Or with CLBLast acceleration
-CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
-# Or with AMD ROCm GPU acceleration (Linux only)
-CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
-# Or with Metal GPU acceleration for macOS systems only
-CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python
+<span style="text-decoration:underline;">Safety</span>
 
-# In windows, to set the variables CMAKE_ARGS in PowerShell, follow this format; eg for NVidia CUDA:
-$env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
-pip install llama-cpp-python
-```
+For our instruction tuned model, we conducted extensive red teaming exercises, performed adversarial evaluations and implemented safety mitigations techniques to lower residual risks. As with any Large Language Model, residual risks will likely remain and we recommend that developers assess these risks in the context of their use case. In parallel, we are working with the community to make AI safety benchmark standards transparent, rigorous and interpretable. 
 
-#### Simple llama-cpp-python example code
+<span style="text-decoration:underline;">Refusals</span>
 
-```python
-from llama_cpp import Llama
-
-# Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
-llm = Llama(
-  model_path="./Meta-Llama-3-8B-Instruct.Q4_K_M.gguf",  # Download the model file first
-  n_ctx=32768,  # The max sequence length to use - note that longer sequence lengths require much more resources
-  n_threads=8,            # The number of CPU threads to use, tailor to your system and the resulting performance
-  n_gpu_layers=35         # The number of layers to offload to GPU, if you have GPU acceleration available
-)
+In addition to residual risks, we put a great emphasis on model refusals to benign prompts. Over-refusing not only can impact the user experience but could even be harmful in certain contexts as well. We’ve heard the feedback from the developer community and improved our fine tuning to ensure that Llama 3 is significantly less likely to falsely refuse to answer prompts than Llama 2. 
 
-# Simple inference example
-output = llm(
-  "<|im_start|>system
-{system_message}<|im_end|>
-<|im_start|>user
-{prompt}<|im_end|>
-<|im_start|>assistant", # Prompt
-  max_tokens=512,  # Generate up to 512 tokens
-  stop=["</s>"],   # Example stop token - not necessarily correct for this specific model! Please check before using.
-  echo=True        # Whether to echo the prompt
-)
+We built internal benchmarks and developed mitigations to limit false refusals making Llama 3 our most helpful model to date. 
 
-# Chat Completion API
-
-llm = Llama(model_path="./Meta-Llama-3-8B-Instruct.Q4_K_M.gguf", chat_format="llama-2")  # Set chat_format according to the model you are using
-llm.create_chat_completion(
-    messages = [
-        {"role": "system", "content": "You are a story writing assistant."},
-        {
-            "role": "user",
-            "content": "Write a story about llamas."
-        }
-    ]
-)
-```
 
-## How to use with LangChain
+#### Responsible release 
+
+In addition to responsible use considerations outlined above, we followed a rigorous process that requires us to take extra measures against misuse and critical risks before we make our release decision. 
+
+Misuse
+
+If you access or use Llama 3, you agree to the Acceptable Use Policy. The most recent copy of this policy can be found at [https://llama.meta.com/llama3/use-policy/](https://llama.meta.com/llama3/use-policy/).
+
+
+#### Critical risks 
+
+<span style="text-decoration:underline;">CBRNE</span> (Chemical, Biological, Radiological, Nuclear, and high yield Explosives)
+
+We have conducted a two fold assessment of the safety of the model in this area:
+
+
+
+* Iterative testing during model training to assess the safety of responses related to CBRNE threats and other adversarial risks.
+* Involving external CBRNE experts to conduct an uplift test assessing the ability of the model to accurately provide expert knowledge and reduce barriers to potential CBRNE misuse, by reference to what can be achieved using web search (without the model).
+
+
+### <span style="text-decoration:underline;">Cyber Security </span>
+
+We have evaluated Llama 3 with CyberSecEval, Meta’s cybersecurity safety eval suite, measuring Llama 3’s propensity to suggest insecure code when used as a coding assistant, and Llama 3’s propensity to comply with requests to help carry out cyber attacks, where attacks are defined by the industry standard MITRE ATT&CK cyber attack ontology. On our insecure coding and cyber attacker helpfulness tests, Llama 3 behaved in the same range or safer than models of [equivalent coding capability](https://huggingface.co/spaces/facebook/CyberSecEval). 
+
 
-Here are guides on using llama-cpp-python and ctransformers with LangChain:
+### <span style="text-decoration:underline;">Child Safety</span>
 
-* [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
-* [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
+Child Safety risk assessments were conducted using a team of experts, to assess the model’s capability to produce outputs that could result in Child Safety risks and inform on any necessary and appropriate risk mitigations via fine tuning. We leveraged those expert red teaming sessions to expand the coverage of our evaluation benchmarks through Llama 3 model development.  For Llama 3, we conducted new in-depth sessions using objective based methodologies to assess the model risks along multiple attack vectors. We also partnered with content specialists to perform red teaming exercises assessing potentially violating content while taking account of market specific nuances or experiences. 
+
+
+### Community 
+
+Generative AI safety requires expertise and tooling, and we believe in the strength of the open community to accelerate its progress. We are active members of open consortiums, including the AI Alliance, Partnership in AI and MLCommons, actively contributing to safety standardization and transparency. We encourage the community to adopt taxonomies like the MLCommons Proof of Concept evaluation to facilitate collaboration and transparency on safety and content evaluations. Our Purple Llama tools are open sourced for the community to use and widely distributed across ecosystem partners including cloud service providers. We encourage community contributions to our [Github repository](https://github.com/meta-llama/PurpleLlama). 
+
+Finally, we put in place a set of resources including an [output reporting mechanism](https://developers.facebook.com/llama_output_feedback) and [bug bounty program](https://www.facebook.com/whitehat) to continuously improve the Llama technology with the help of the community. 
+
+
+## Ethical Considerations and Limitations
+
+The core values of Llama 3 are openness, inclusivity and helpfulness. It is meant to serve everyone, and to work for a wide range of use cases. It is thus designed to be accessible to people across many different backgrounds, experiences and perspectives. Llama 3 addresses users and their needs as they are, without insertion unnecessary judgment or normativity, while reflecting the understanding that even content that may appear problematic in some cases can serve valuable purposes in others. It respects the dignity and autonomy of all users, especially in terms of the values of free thought and expression that power innovation and progress. 
+
+But Llama 3 is a new technology, and like any new technology, there are risks associated with its use. Testing conducted to date has been in English, and has not covered, nor could it cover, all scenarios. For these reasons, as with all LLMs, Llama 3’s potential outputs cannot be predicted in advance, and the model may in some instances produce inaccurate, biased or other objectionable responses to user prompts. Therefore, before deploying any applications of Llama 3 models, developers should perform safety testing and tuning tailored to their specific applications of the model. As outlined in the Responsible Use Guide, we recommend incorporating [Purple Llama](https://github.com/facebookresearch/PurpleLlama) solutions into your workflows and specifically [Llama Guard](https://ai.meta.com/research/publications/llama-guard-llm-based-input-output-safeguard-for-human-ai-conversations/) which provides a base model to filter input and output prompts to layer system-level safety on top of model-level safety. 
+
+Please see the Responsible Use Guide available at [http://llama.meta.com/responsible-use-guide](http://llama.meta.com/responsible-use-guide)
+
+
+## Citation instructions
+
+@article{llama3modelcard,
+
+  title={Llama 3 Model Card},
+
+  author={AI@Meta},
+
+  year={2024},
+
+  url = {https://github.com/meta-llama/llama3/blob/main/MODEL_CARD.md}
+
+}
+
+## Contributors
+
+Aaditya Singh; Aaron Grattafiori; Abhimanyu Dubey; Abhinav Jauhri; Abhinav Pandey; Abhishek Kadian; Adam Kelsey; Adi Gangidi; Ahmad Al-Dahle; Ahuva Goldstand; Aiesha Letman; Ajay Menon; Akhil Mathur; Alan Schelten; Alex Vaughan; Amy Yang; Andrei Lupu; Andres Alvarado; Andrew Gallagher; Andrew Gu; Andrew Ho; Andrew Poulton; Andrew Ryan; Angela Fan; Ankit Ramchandani; Anthony Hartshorn; Archi Mitra; Archie Sravankumar; Artem Korenev; Arun Rao; Ashley Gabriel; Ashwin Bharambe; Assaf Eisenman; Aston Zhang; Aurelien Rodriguez; Austen Gregerson; Ava Spataru; Baptiste Roziere; Ben Maurer; Benjamin Leonhardi; Bernie Huang; Bhargavi Paranjape; Bing Liu; Binh Tang; Bobbie Chern; Brani Stojkovic; Brian Fuller; Catalina Mejia Arenas; Chao Zhou; Charlotte Caucheteux; Chaya Nayak; Ching-Hsiang Chu; Chloe Bi; Chris Cai; Chris Cox; Chris Marra; Chris McConnell; Christian Keller; Christoph Feichtenhofer; Christophe Touret; Chunyang Wu; Corinne Wong; Cristian Canton Ferrer; Damien Allonsius; Daniel Kreymer; Daniel Haziza; Daniel Li; Danielle Pintz; Danny Livshits; Danny Wyatt; David Adkins; David Esiobu; David Xu; Davide Testuggine; Delia David; Devi Parikh; Dhruv Choudhary; Dhruv Mahajan; Diana Liskovich; Diego Garcia-Olano; Diego Perino; Dieuwke Hupkes; Dingkang Wang; Dustin Holland; Egor Lakomkin; Elina Lobanova; Xiaoqing Ellen Tan; Emily Dinan; Eric Smith; Erik Brinkman; Esteban Arcaute; Filip Radenovic; Firat Ozgenel; Francesco Caggioni; Frank Seide; Frank Zhang; Gabriel Synnaeve; Gabriella Schwarz; Gabrielle Lee; Gada Badeer; Georgia Anderson; Graeme Nail; Gregoire Mialon; Guan Pang; Guillem Cucurell; Hailey Nguyen; Hannah Korevaar; Hannah Wang; Haroun Habeeb; Harrison Rudolph; Henry Aspegren; Hu Xu; Hugo Touvron; Iga Kozlowska; Igor Molybog; Igor Tufanov; Iliyan Zarov; Imanol Arrieta Ibarra; Irina-Elena Veliche; Isabel Kloumann; Ishan Misra; Ivan Evtimov; Jacob Xu; Jade Copet; Jake Weissman; Jan Geffert; Jana Vranes; Japhet Asher; Jason Park; Jay Mahadeokar; Jean-Baptiste Gaya; Jeet Shah; Jelmer van der Linde; Jennifer Chan; Jenny Hong; Jenya Lee; Jeremy Fu; Jeremy Teboul; Jianfeng Chi; Jianyu Huang; Jie Wang; Jiecao Yu; Joanna Bitton; Joe Spisak; Joelle Pineau; Jon Carvill; Jongsoo Park; Joseph Rocca; Joshua Johnstun; Junteng Jia; Kalyan Vasuden Alwala; Kam Hou U; Kate Plawiak; Kartikeya Upasani; Kaushik Veeraraghavan; Ke Li; Kenneth Heafield; Kevin Stone; Khalid El-Arini; Krithika Iyer; Kshitiz Malik; Kuenley Chiu; Kunal Bhalla; Kyle Huang; Lakshya Garg; Lauren Rantala-Yeary; Laurens van der Maaten; Lawrence Chen; Leandro Silva; Lee Bell; Lei Zhang; Liang Tan; Louis Martin; Lovish Madaan; Luca Wehrstedt; Lukas Blecher; Luke de Oliveira; Madeline Muzzi; Madian Khabsa; Manav Avlani; Mannat Singh; Manohar Paluri; Mark Zuckerberg; Marcin Kardas; Martynas Mankus; Mathew Oldham; Mathieu Rita; Matthew Lennie; Maya Pavlova; Meghan Keneally; Melanie Kambadur; Mihir Patel; Mikayel Samvelyan; Mike Clark; Mike Lewis; Min Si; Mitesh Kumar Singh; Mo Metanat; Mona Hassan; Naman Goyal; Narjes Torabi; Nicolas Usunier; Nikolay Bashlykov; Nikolay Bogoychev; Niladri Chatterji; Ning Dong; Oliver Aobo Yang; Olivier Duchenne; Onur Celebi; Parth Parekh; Patrick Alrassy; Paul Saab; Pavan Balaji; Pedro Rittner; Pengchuan Zhang; Pengwei Li; Petar Vasic; Peter Weng; Polina Zvyagina; Prajjwal Bhargava; Pratik Dubal; Praveen Krishnan; Punit Singh Koura; Qing He; Rachel Rodriguez; Ragavan Srinivasan; Rahul Mitra; Ramon Calderer; Raymond Li; Robert Stojnic; Roberta Raileanu; Robin Battey; Rocky Wang; Rohit Girdhar; Rohit Patel; Romain Sauvestre; Ronnie Polidoro; Roshan Sumbaly; Ross Taylor; Ruan Silva; Rui Hou; Rui Wang; Russ Howes; Ruty Rinott; Saghar Hosseini; Sai Jayesh Bondu; Samyak Datta; Sanjay Singh; Sara Chugh; Sargun Dhillon; Satadru Pan; Sean Bell; Sergey Edunov; Shaoliang Nie; Sharan Narang; Sharath Raparthy; Shaun Lindsay; Sheng Feng; Sheng Shen; Shenghao Lin; Shiva Shankar; Shruti Bhosale; Shun Zhang; Simon Vandenhende; Sinong Wang; Seohyun Sonia Kim; Soumya Batra; Sten Sootla; Steve Kehoe; Suchin Gururangan; Sumit Gupta; Sunny Virk; Sydney Borodinsky; Tamar Glaser; Tamar Herman; Tamara Best; Tara Fowler; Thomas Georgiou; Thomas Scialom; Tianhe Li; Todor Mihaylov; Tong Xiao; Ujjwal Karn; Vedanuj Goswami; Vibhor Gupta; Vignesh Ramanathan; Viktor Kerkez; Vinay Satish Kumar; Vincent Gonguet; Vish Vogeti; Vlad Poenaru; Vlad Tiberiu Mihailescu; Vladan Petrovic; Vladimir Ivanov; Wei Li; Weiwei Chu; Wenhan Xiong; Wenyin Fu; Wes Bouaziz; Whitney Meers; Will Constable; Xavier Martinet; Xiaojian Wu; Xinbo Gao; Xinfeng Xie; Xuchao Jia; Yaelle Goldschlag; Yann LeCun; Yashesh Gaur; Yasmine Babaei; Ye Qi; Yenda Li; Yi Wen; Yiwen Song; Youngjin Nam; Yuchen Hao; Yuchen Zhang; Yun Wang; Yuning Mao; Yuzi He; Zacharie Delpierre Coudert; Zachary DeVito; Zahra Hankir; Zhaoduo Wen; Zheng Yan; Zhengxing Chen; Zhenyu Yang; Zoe Papakipos
+
+---