pcuenq's picture
pcuenq HF staff
Update Model Card
2826050 verified
metadata
extra_gated_heading: You need to share contact information with Meta to access this model
extra_gated_prompt: >-
  ### LLAMA 2 COMMUNITY LICENSE AGREEMENT

  "Agreement" means the terms and conditions for use, reproduction, distribution
  and  modification of the Llama Materials set forth herein.  "Documentation"
  means the specifications, manuals and documentation  accompanying Llama 2
  distributed by Meta at
  https://ai.meta.com/resources/models-and-libraries/llama-downloads/.  
  "Licensee" or "you" means you, or your employer or any other person or entity
  (if you are entering into this Agreement on such person or entity's behalf),
  of the age required under applicable laws, rules or regulations to provide
  legal consent and that has legal authority to bind your employer or such other
  person or  entity if you are  entering in this Agreement on their behalf. 
  "Llama 2" means the foundational large language models and software and
  algorithms, including machine-learning model code, trained model weights,
  inference-enabling code, training-enabling code, fine-tuning enabling code and
  other  elements of the foregoing distributed by Meta at
  ai.meta.com/resources/models-and-libraries/llama-downloads/. "Llama Materials"
  means, collectively, Meta's proprietary Llama 2 and documentation (and any
  portion thereof) made available under this Agreement. "Meta" or "we" means
  Meta Platforms Ireland Limited (if you are located in or, if you are an
  entity, your principal place of business is in the EEA or Switzerland) and
  Meta Platforms, Inc. (if you are located outside of the EEA or Switzerland). 
  By clicking "I Accept" below or by using or distributing any portion or
  element of the Llama Materials, you agree to be bound by this Agreement. 1.
  License Rights and Redistribution.  a. Grant of Rights. You are granted a
  non-exclusive, worldwide, non- transferable and royalty-free limited license
  under Meta's intellectual property or  other rights owned by Meta embodied in
  the Llama Materials to use, reproduce,  distribute, copy, create derivative
  works of, and make modifications to the Llama  Materials.  
     
  b. Redistribution and Use.   i. If you distribute or make the Llama Materials,
  or any derivative works  thereof, available to a third party, you shall
  provide a copy of this Agreement to such  third party.  ii.  If you receive
  Llama Materials, or any derivative works thereof, from  a Licensee as part of
  an integrated end user product, then Section 2 of this  Agreement will not
  apply to you.  iii. You must retain in all copies of the Llama Materials that
  you  distribute the following attribution notice within a "Notice" text file
  distributed as a  part of such copies: "Llama 2 is licensed under the LLAMA 2
  Community License,  Copyright (c) Meta Platforms, Inc. All Rights Reserved."
  iv. Your use of the Llama Materials must comply with applicable laws  and
  regulations (including trade compliance laws and regulations) and adhere to
  the  Acceptable Use Policy for the Llama Materials (available at 
  https://ai.meta.com/llama/use-policy), which is hereby incorporated by
  reference into  this Agreement. v. You will not use the Llama Materials or any
  output or results of the  Llama Materials to improve any other large language
  model (excluding Llama 2 or  derivative works thereof).   2. Additional
  Commercial Terms. If, on the Llama 2 version release date, the  monthly active
  users of the products or services made available by or for Licensee,  or
  Licensee's affiliates, is greater than 700 million monthly active users in
  the  preceding calendar month, you must request a license from Meta, which
  Meta may  grant to you in its sole discretion, and you are not authorized to
  exercise any of the  rights under this Agreement unless or until Meta
  otherwise expressly grants you  such rights. 3. Disclaimer of Warranty. UNLESS
  REQUIRED BY APPLICABLE LAW, THE  LLAMA MATERIALS AND ANY OUTPUT AND RESULTS
  THEREFROM ARE  PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, 
  EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY  WARRANTIES OF
  TITLE, NON-INFRINGEMENT, MERCHANTABILITY, OR  FITNESS FOR A PARTICULAR
  PURPOSE. YOU ARE SOLELY RESPONSIBLE  FOR DETERMINING THE APPROPRIATENESS OF
  USING OR REDISTRIBUTING  THE LLAMA MATERIALS AND ASSUME ANY RISKS ASSOCIATED
  WITH YOUR  USE OF THE LLAMA MATERIALS AND ANY OUTPUT AND RESULTS. 4.
  Limitation of Liability. IN NO EVENT WILL META OR ITS AFFILIATES BE  LIABLE
  UNDER ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, TORT,  NEGLIGENCE,
  PRODUCTS LIABILITY, OR OTHERWISE, ARISING OUT OF THIS  AGREEMENT, FOR ANY LOST
  PROFITS OR ANY INDIRECT, SPECIAL,  CONSEQUENTIAL, INCIDENTAL, EXEMPLARY OR
  PUNITIVE DAMAGES, EVEN  IF META OR ITS AFFILIATES HAVE BEEN ADVISED OF THE
  POSSIBILITY OF  ANY OF THE FOREGOING. 5. Intellectual Property. a. No
  trademark licenses are granted under this Agreement, and in  connection with
  the Llama Materials, neither Meta nor Licensee may use any name  or mark owned
  by or associated with the other or any of its affiliates, except as  required
  for reasonable and customary use in describing and redistributing the  Llama
  Materials. b. Subject to Meta's ownership of Llama Materials and derivatives
  made by or  for Meta, with respect to any derivative works and modifications
  of the Llama  Materials that are made by you, as between you and Meta, you are
  and will be the  owner of such derivative works and modifications. c. If you
  institute litigation or other proceedings against Meta or any entity 
  (including a cross-claim or counterclaim in a lawsuit) alleging that the
  Llama  Materials or Llama 2 outputs or results, or any portion of any of the
  foregoing,  constitutes infringement of intellectual property or other rights
  owned or licensable  by you, then any licenses granted to you under this
  Agreement shall terminate as of  the date such litigation or claim is filed or
  instituted. You will indemnify and hold  harmless Meta from and against any
  claim by any third party arising out of or related  to your use or
  distribution of the Llama Materials. 6. Term and Termination. The term of this
  Agreement will commence upon your  acceptance of this Agreement or access to
  the Llama Materials and will continue in  full force and effect until
  terminated in accordance with the terms and conditions  herein. Meta may
  terminate this Agreement if you are in breach of any term or  condition of
  this Agreement. Upon termination of this Agreement, you shall delete  and
  cease use of the Llama Materials. Sections 3, 4 and 7 shall survive the 
  termination of this Agreement.  7. Governing Law and Jurisdiction. This
  Agreement will be governed and  construed under the laws of the State of
  California without regard to choice of law  principles, and the UN Convention
  on Contracts for the International Sale of Goods  does not apply to this
  Agreement. The courts of California shall have exclusive  jurisdiction of any
  dispute arising out of this Agreement.  USE POLICY ### Llama 2 Acceptable Use
  Policy Meta is committed to promoting safe and fair use of its tools and
  features, including Llama 2. If you access or use Llama 2, you agree to this
  Acceptable Use Policy (“Policy”). The most recent copy of this policy can be
  found at [ai.meta.com/llama/use-policy](http://ai.meta.com/llama/use-policy).
  #### Prohibited Uses We want everyone to use Llama 2 safely and responsibly.
  You agree you will not use, or allow others to use, Llama 2 to:  1. Violate
  the law or others’ rights, including to:
    1. Engage in, promote, generate, contribute to, encourage, plan, incite, or further illegal or unlawful activity or content, such as: 
      1. Violence or terrorism 
      2. Exploitation or harm to children, including the solicitation, creation, acquisition, or dissemination of child exploitative content or failure to report Child Sexual Abuse Material
      3. Human trafficking, exploitation, and sexual violence
      4. The illegal distribution of information or materials to minors, including obscene materials, or failure to employ legally required age-gating in connection with such information or materials.
      5. Sexual solicitation
      6. Any other criminal activity
    2. Engage in, promote, incite, or facilitate the harassment, abuse, threatening, or bullying of individuals or groups of individuals
    3. Engage in, promote, incite, or facilitate discrimination or other unlawful or harmful conduct in the provision of employment, employment benefits, credit, housing, other economic benefits, or other essential goods and services
    4. Engage in the unauthorized or unlicensed practice of any profession including, but not limited to, financial, legal, medical/health, or related professional practices 
    5. Collect, process, disclose, generate, or infer health, demographic, or other sensitive personal or private information about individuals without rights and consents required by applicable laws
    6. Engage in or facilitate any action or generate any content that infringes, misappropriates, or otherwise violates any third-party rights, including the outputs or results of any products or services using the Llama 2 Materials
    7. Create, generate, or facilitate the creation of malicious code, malware, computer viruses or do anything else that could disable, overburden, interfere with or impair the proper working, integrity, operation or appearance of a website or computer system 
  2. Engage in, promote, incite, facilitate, or assist in the planning or
  development of activities that present a risk of death or bodily harm to
  individuals, including use of Llama 2 related to the following:
    1. Military, warfare, nuclear industries or applications, espionage, use for materials or activities that are subject to the International Traffic Arms Regulations (ITAR) maintained by the United States Department of State
    2. Guns and illegal weapons (including weapon development)
    3. Illegal drugs and regulated/controlled substances
    4. Operation of critical infrastructure, transportation technologies, or heavy machinery
    5. Self-harm or harm to others, including suicide, cutting, and eating disorders
    6. Any content intended to incite or promote violence, abuse, or any infliction of bodily harm to an individual
  3. Intentionally deceive or mislead others, including use of Llama 2 related
  to the following:
    1. Generating, promoting, or furthering fraud or the creation or promotion of disinformation
    2. Generating, promoting, or furthering defamatory content, including the creation of defamatory statements, images, or other content
    3. Generating, promoting, or further distributing spam
    4. Impersonating another individual without consent, authorization, or legal right
    5. Representing that the use of Llama 2 or outputs are human-generated
    6. Generating or facilitating false online engagement, including fake reviews and other means of fake online engagement 
    4. Fail to appropriately disclose to end users any known dangers of your AI system 
  Please report any violation of this Policy, software “bug,” or other problems
  that could lead to a violation of this Policy through one of the following
  means: * Reporting issues with the model:
  [github.com/facebookresearch/llama](http://github.com/facebookresearch/llama)
  * Reporting risky content generated by the model:
  [developers.facebook.com/llama_output_feedback](http://developers.facebook.com/llama_output_feedback)
  * Reporting bugs and security concerns:
  [facebook.com/whitehat/info](http://facebook.com/whitehat/info) * Reporting
  violations of the Acceptable Use Policy or unlicensed uses of Llama:
  [[email protected]](mailto:[email protected])
extra_gated_fields:
  First Name: text
  Last Name: text
  Date of birth: date_picker
  Country: country
  Affiliation: text
  geo: ip_location
  By clicking Submit below I accept the terms of the license and acknowledge that the information I provide will be collected stored processed and shared in accordance with the Meta Privacy Policy: checkbox
extra_gated_description: >-
  The information you provide will be collected, stored, processed and shared in
  accordance with the [Meta Privacy
  Policy](https://www.facebook.com/privacy/policy/).
extra_gated_button_content: Submit
language:
  - code
pipeline_tag: text-generation
tags:
  - facebook
  - meta
  - pytorch
  - llama
  - llama-2
license: llama2
widget:
  - example_title: Hello world (Python)
    messages:
      - role: system
        content: You are a helpful and honest code assistant
      - role: user
        content: Print a hello world in Python
  - example_title: Sum of sublists (Python)
    messages:
      - role: system
        content: >-
          You are a helpful and honest code assistant expert in JavaScript.
          Please, provide all answers to programming questions in JavaScript
      - role: user
        content: >-
          Write a function that computes the set of sums of all contiguous
          sublists of a given list.
inference:
  parameters:
    max_new_tokens: 200
    stop:
      - </s>
      - <step>

Code Llama

Code Llama is a collection of pretrained and fine-tuned generative text models ranging in scale from 7 billion to 70 billion parameters. This is the repository for the 70B instruct-tuned version in the Hugging Face Transformers format. This model is designed for general code synthesis and understanding. Links to other models can be found in the index at the bottom.

Model capabilities:

  • Code completion.
  • Infilling.
  • Instructions / chat.
  • Python specialist.

Model Use

To use this model, please make sure to install transformers:

pip install transformers accelerate

Chat use: The 70B Instruct model uses a different prompt template than the smaller versions. To use it with transformers, we recommend you use the built-in chat template:

from transformers import AutoTokenizer, AutoModelForCausalLM
import transformers
import torch

model_id = "meta-llama/CodeLlama-70b-Instruct-hf"
tokenizer = AutoTokenizer.from_pretrained(model_id)
model = AutoModelForCausalLM.from_pretrained(
   model_id,
   torch_dtype=torch.float16,
   device_map="auto",
)

chat = [
   {"role": "system", "content": "You are a helpful and honest code assistant expert in JavaScript. Please, provide all answers to programming questions in JavaScript"},
   {"role": "user", "content": "Write a function that computes the set of sums of all contiguous sublists of a given list."},
]
inputs = tokenizer.apply_chat_template(chat, return_tensors="pt").to("cuda")

output = model.generate(input_ids=inputs, max_new_tokens=200)
output = output[0].to("cpu")
print(tokenizer.decode(output))

You can also use the model for text or code completion. This examples uses transformers' pipeline interface:

from transformers import AutoTokenizer
import transformers
import torch

model_id = "meta-llama/CodeLlama-70b-hf"
tokenizer = AutoTokenizer.from_pretrained(model_id)
pipeline = transformers.pipeline(
   "text-generation",
   model=model_id,
   torch_dtype=torch.float16,
   device_map="auto",
)

sequences = pipeline(
   'def fibonacci(',
   do_sample=True,
   temperature=0.2,
   top_p=0.9,
   num_return_sequences=1,
   eos_token_id=tokenizer.eos_token_id,
   max_length=100,
)
for seq in sequences:
   print(f"Result: {seq['generated_text']}")

Chat prompt

CodeLlama 70B Instruct uses a different format for the chat prompt than previous Llama 2 or CodeLlama models. As mentioned above, the easiest way to use it is with the help of the tokenizer's chat template. If you need to build the string or tokens, manually, here's how to do it.

We'll do our tests with the following made-up dialog:

chat = [
    {"role": "system", "content": "System prompt    "},
    {"role": "user", "content": "First user query"},
    {"role": "assistant", "content": "Model response to first query"},
    {"role": "user", "content": "Second user query"},
]

First, let's see what the prompt looks like if we use the chat template:

tokenizer.apply_chat_template(chat, tokenize=False)
'<s>Source: system\n\n System prompt <step> Source: user\n\n First user query <step> Source: assistant\n\n Model response to first query <step> Source: user\n\n Second user query <step> Source: assistant\nDestination: user\n\n '

So each turn of the conversation has a Source (system, user, or assistant), and then the content appears after two newlines and a space. Turns are separated with the special token <step>. After the last turn (which must necessarily come from the user), we invite the model to respond by using the special syntax Source: assistant\nDestination: user\n\n . Let's see how we can build the same string ourselves:

output = "<s>"
for m in chat:
    output += f"Source: {m['role']}\n\n {m['content'].strip()}"
    output += " <step> "
output += "Source: assistant\nDestination: user\n\n "
output
'<s>Source: system\n\n System prompt <step> Source: user\n\n First user query <step> Source: assistant\n\n Model response to first query <step> Source: user\n\n Second user query <step> Source: assistant\nDestination: user\n\n '

To verify that we got it right, we'll compare against the reference code in the original GitHub repo. We used the same dialog and tokenized it with the dialog_prompt_tokens function and got the following tokens:

reference_tokens = [1, 7562, 29901, 1788, 13, 13, 2184, 9508, 32015, 7562, 29901, 1404, 13, 13, 3824, 1404, 2346, 32015, 7562, 29901, 20255, 13, 13, 8125, 2933, 304, 937, 2346, 32015, 7562, 29901, 1404, 13, 13, 6440, 1404, 2346, 32015, 7562, 29901, 20255, 13, 14994, 3381, 29901, 1404, 13, 13, 29871]

Let's see what we get with the string we built using our Python loop. Note that we don't add "special tokens" because the string already starts with <s>, the beginning of sentence token:

tokens = tokenizer.encode(output, add_special_tokens=False)
assert reference_tokens == tokens

Similarly, let's verify that the chat template produces the same token sequence:

assert reference_tokens == tokenizer.apply_chat_template(chat)

As a final detail, please note that if the dialog does not start with a system turn, the original code will insert one with an empty content string.

Model Details

*Note: Use of this model is governed by the Meta license. Meta developed and publicly released the Code Llama family of large language models (LLMs).

Model Developers Meta

Variations Code Llama comes in four model sizes, and three variants:

  • Code Llama: base models designed for general code synthesis and understanding
  • Code Llama - Python: designed specifically for Python
  • Code Llama - Instruct: for instruction following and safer deployment

All variants are available in sizes of 7B, 13B, 34B, and 70B parameters.

This repository contains the Instruct version of the 70B parameters model.

Input Models input text only.

Output Models generate text only.

Model Architecture Code Llama is an auto-regressive language model that uses an optimized transformer architecture. It was fine-tuned with up to 16k tokens. This variant does not support long context of up to 100k tokens.

Model Dates Code Llama and its variants have been trained between January 2023 and January 2024.

Status This is a static model trained on an offline dataset. Future versions of Code Llama - Instruct will be released as we improve model safety with community feedback.

License A custom commercial license is available at: https://ai.meta.com/resources/models-and-libraries/llama-downloads/

Research Paper More information can be found in the paper "Code Llama: Open Foundation Models for Code" or its arXiv page.

Intended Use

Intended Use Cases Code Llama and its variants are intended for commercial and research use in English and relevant programming languages. The base model Code Llama can be adapted for a variety of code synthesis and understanding tasks, Code Llama - Python is designed specifically to handle the Python programming language, and Code Llama - Instruct is intended to be safer to use for code assistant and generation applications.

Out-of-Scope Uses Use in any manner that violates applicable laws or regulations (including trade compliance laws). Use in languages other than English. Use in any other way that is prohibited by the Acceptable Use Policy and Licensing Agreement for Code Llama and its variants.

Hardware and Software

Training Factors We used custom training libraries. The training and fine-tuning of the released models have been performed Meta’s Research Super Cluster. Carbon Footprint In aggregate, training all 12 Code Llama models required 1400K GPU hours of computation on hardware of type A100-80GB (TDP of 350-400W). Estimated total emissions were 228.55 tCO2eq, 100% of which were offset by Meta’s sustainability program.

Evaluation Results

See evaluations for the main models and detailed ablations in Section 3 and safety evaluations in Section 4 of the research paper.

Ethical Considerations and Limitations

Code Llama and its variants are a new technology that carries risks with 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, Code Llama’s potential outputs cannot be predicted in advance, and the model may in some instances produce inaccurate or objectionable responses to user prompts. Therefore, before deploying any applications of Code Llama, developers should perform safety testing and tuning tailored to their specific applications of the model.

Please see the Responsible Use Guide available available at https://ai.meta.com/llama/responsible-use-guide.