Update README.md

README.md

@@ -1,199 +1,295 @@
 ---
-library_name: transformers
-tags: []
+language:
+- en
+pipeline_tag: text-generation
+tags:
+- facebook
+- meta
+- pytorch
+- llama
+- llama-3
+license: llama3
+extra_gated_prompt: >-
+  ### META LLAMA 3 COMMUNITY LICENSE AGREEMENT
+
+  Meta Llama 3 Version Release Date: April 18, 2024
+  
+  "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 Meta Llama 3
+  distributed by Meta at https://llama.meta.com/get-started/.
+
+  "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.
+
+  "Meta Llama 3" 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
+  https://llama.meta.com/llama-downloads.
+
+  "Llama Materials" means, collectively, Meta’s proprietary Meta Llama 3 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).
+     
+  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 available the Llama Materials (or any derivative works
+  thereof), or a product or service that uses any of them, including another AI model, you shall (A) provide
+  a copy of this Agreement with any such Llama Materials; and (B) prominently display “Built with Meta
+  Llama 3” on a related website, user interface, blogpost, about page, or product documentation. If you
+  use the Llama Materials to create, train, fine tune, or otherwise improve an AI model, which is
+  distributed or made available, you shall also include “Llama 3” at the beginning of any such AI model
+  name.
+
+  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: “Meta Llama 3 is
+  licensed under the Meta Llama 3 Community License, Copyright © 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://llama.meta.com/llama3/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 Meta Llama 3 or derivative works thereof).
+
+  2. Additional Commercial Terms. If, on the Meta Llama 3 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, AND META DISCLAIMS ALL WARRANTIES OF ANY KIND, BOTH EXPRESS AND 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 or as set forth in this Section 5(a). Meta hereby grants you a license to
+  use “Llama 3” (the “Mark”) solely as required to comply with the last sentence of Section 1.b.i. You will
+  comply with Meta’s brand guidelines (currently accessible at
+  https://about.meta.com/brand/resources/meta/company-brand/ ). All goodwill arising out of your use
+  of the Mark will inure to the benefit of Meta.
+
+  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 Meta Llama 3 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.
+
+  ### Meta Llama 3 Acceptable Use Policy
+
+  Meta is committed to promoting safe and fair use of its tools and features, including Meta Llama 3. If you
+  access or use Meta Llama 3, you agree to this Acceptable Use Policy (“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)
+
+  #### Prohibited Uses
+
+  We want everyone to use Meta Llama 3 safely and responsibly. You agree you will not use, or allow
+  others to use, Meta Llama 3 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 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 Meta Llama 3 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 Meta Llama 3 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 Meta Llama 3 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: [https://github.com/meta-llama/llama3](https://github.com/meta-llama/llama3)
+      * Reporting risky content generated by the model:
+      developers.facebook.com/llama_output_feedback
+      * Reporting bugs and security concerns: facebook.com/whitehat/info
+      * Reporting violations of the Acceptable Use Policy or unlicensed uses of Meta Llama 3: [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
 ---
 
-# Model Card for Model ID
+## Model Details (GPTQ 4bit)
 
-<!-- Provide a quick summary of what the model is/does. -->
+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. 
 
+**Model developers** Meta
 
+**Variations** Llama 3 comes in two sizes — 8B and 70B parameters — in pre-trained and instruction tuned variants.
 
-## Model Details
+**Input** Models input text only.
 
-### Model Description
+**Output** Models generate text and code only.
 
-<!-- Provide a longer summary of what this model is. -->
+**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.
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+<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>
 
-### Model Sources [optional]
 
-<!-- Provide the basic links for the model. -->
+**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.
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+**Model Release Date** April 18, 2024.
 
-## Uses
+**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.
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+**License** A custom commercial license is available at: [https://llama.meta.com/llama3/license](https://llama.meta.com/llama3/license)
 
-### Direct Use
+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). 
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
-[More Information Needed]
+## Intended Use
 
-### Downstream Use [optional]
+**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.
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+**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**.
 
-[More Information Needed]
+**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.
 
-### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+#### Example code
 
-[More Information Needed]
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
 
-## Bias, Risks, and Limitations
+model_name_or_path = "SalmanFaroz/Meta-Llama-3-8B-Instruct-GPTQ"
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
+                                             device_map="auto",
+                                             trust_remote_code=False)
 
-[More Information Needed]
+tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
 
-### Recommendations
+prompt = "Tell me about AI"
+prompt_template=f'''[INST] <<SYS>>
+You are a helpful, respectful and honest assistant. Always answer as helpfully as possible, while being safe.  Your answers should not include any harmful, unethical, racist, sexist, toxic, dangerous, or illegal content. Please ensure that your responses are socially unbiased and positive in nature. If a question does not make any sense, or is not factually coherent, explain why instead of answering something not correct. If you don't know the answer to a question, please don't share false information.
+<</SYS>>
+{prompt}[/INST]
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+'''
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+print("\n\n*** Generate:")
 
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+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]))
+```