filopedraz commited on
Commit
59358fd
1 Parent(s): 4048bc1

updated model card

Browse files
Files changed (1) hide show
  1. README.md +15 -67
README.md CHANGED
@@ -6,80 +6,28 @@ tags:
6
  - llama-2
7
  license: llama2
8
  ---
9
- # **Code Llama**
10
- Code Llama is a collection of pretrained and fine-tuned generative text models ranging in scale from 7 billion to 34 billion parameters. This is the repository for the 34B 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.
11
 
12
- | | Base Model | Python | Instruct |
13
- | --- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
14
- | 7B | [codellama/CodeLlama-7b-hf](https://huggingface.co/codellama/CodeLlama-7b-hf) | [codellama/CodeLlama-7b-Python-hf](https://huggingface.co/codellama/CodeLlama-7b-Python-hf) | [codellama/CodeLlama-7b-Instruct-hf](https://huggingface.co/codellama/CodeLlama-7b-Instruct-hf) |
15
- | 13B | [codellama/CodeLlama-13b-hf](https://huggingface.co/codellama/CodeLlama-13b-hf) | [codellama/CodeLlama-13b-Python-hf](https://huggingface.co/codellama/CodeLlama-13b-Python-hf) | [codellama/CodeLlama-13b-Instruct-hf](https://huggingface.co/codellama/CodeLlama-13b-Instruct-hf) |
16
- | 34B | [codellama/CodeLlama-34b-hf](https://huggingface.co/codellama/CodeLlama-34b-hf) | [codellama/CodeLlama-34b-Python-hf](https://huggingface.co/codellama/CodeLlama-34b-Python-hf) | [codellama/CodeLlama-34b-Instruct-hf](https://huggingface.co/codellama/CodeLlama-34b-Instruct-hf) |
17
 
18
- ## Model Use
19
 
20
- To use this model, please make sure to install transformers from `main` until the next version is released:
21
 
22
- ```bash
23
- pip install git+https://github.com/huggingface/transformers.git@main accelerate
24
- ```
25
-
26
- Model capabilities:
27
-
28
- - [x] Code completion.
29
- - [ ] Infilling.
30
- - [x] Instructions / chat.
31
- - [ ] Python specialist.
32
-
33
- ## Model Details
34
- *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).
35
-
36
- **Model Developers** Meta
37
-
38
- **Variations** Code Llama comes in three model sizes, and three variants:
39
-
40
- * Code Llama: base models designed for general code synthesis and understanding
41
- * Code Llama - Python: designed specifically for Python
42
- * Code Llama - Instruct: for instruction following and safer deployment
43
-
44
- All variants are available in sizes of 7B, 13B and 34B parameters.
45
-
46
- **This repository contains the Instruct version of the 34B parameters model.**
47
-
48
- **Input** Models input text only.
49
-
50
- **Output** Models generate text only.
51
-
52
- **Model Architecture** Code Llama is an auto-regressive language model that uses an optimized transformer architecture.
53
 
54
- **Model Dates** Code Llama and its variants have been trained between January 2023 and July 2023.
55
-
56
- **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.
57
-
58
- **License** A custom commercial license is available at: [https://ai.meta.com/resources/models-and-libraries/llama-downloads/](https://ai.meta.com/resources/models-and-libraries/llama-downloads/)
59
-
60
- **Research Paper** More information can be found in the paper "[Code Llama: Open Foundation Models for Code](https://ai.meta.com/research/publications/code-llama-open-foundation-models-for-code/)" or its [arXiv page](https://arxiv.org/abs/2308.12950).
61
-
62
- ## Intended Use
63
- **Intended Use Cases** Code Llama and its variants is 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.
64
-
65
- **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.
66
-
67
- ## Hardware and Software
68
- **Training Factors** We used custom training libraries. The training and fine-tuning of the released models have been performed Meta’s Research Super Cluster.
69
-
70
- **Carbon Footprint** In aggregate, training all 9 Code Llama models required 400K GPU hours of computation on hardware of type A100-80GB (TDP of 350-400W). Estimated total emissions were 65.3 tCO2eq, 100% of which were offset by Meta’s sustainability program.
71
-
72
- ## Training Data
73
-
74
- All experiments reported here and the released models have been trained and fine-tuned using the same data as Llama 2 with different weights (see Section 2 and Table 1 in the [research paper](https://ai.meta.com/research/publications/code-llama-open-foundation-models-for-code/) for details).
75
-
76
- ## Evaluation Results
77
-
78
- See evaluations for the main models and detailed ablations in Section 3 and safety evaluations in Section 4 of the research paper.
79
 
 
 
 
 
80
 
81
- ## Ethical Considerations and Limitations
82
 
83
  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.
84
 
85
- Please see the Responsible Use Guide available available at [https://ai.meta.com/llama/responsible-user-guide](https://ai.meta.com/llama/responsible-user-guide).
 
6
  - llama-2
7
  license: llama2
8
  ---
9
+ # Code Llama for Petals
 
10
 
11
+ Resharded Code Llama repository optimized for Petals inference. Instead of having 7 of ~10GiB each, the current repository has 49 shards each one of ~1.5GiB.
 
 
 
 
12
 
13
+ For more information about the model, you can check the official card [here](https://huggingface.co/codellama/CodeLlama-34b-Instruct-hf).
14
 
15
+ # Getting Started
16
 
17
+ ```python
18
+ # pip install git+https://github.com/huggingface/transformers.git@main accelerate
19
+ from transformers import LlamaTokenizer, AutoModelForCausalLM
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
20
 
21
+ tokenizer = LlamaTokenizer.from_pretrained("premai-io/CodeLlama-34b-Instruct-hf")
22
+ model = AutoModelForCausalLM.from_pretrained("premai-io/CodeLlama-34b-Instruct-hf")
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23
 
24
+ inputs = tokenizer("def hello_world():", return_tensors="pt")["input_ids"]
25
+ outputs = model.generate(inputs, max_new_tokens=100)
26
+ print(tokenizer.decode(outputs[0]))
27
+ ```
28
 
29
+ # Ethical Considerations and Limitations
30
 
31
  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.
32
 
33
+ Please see the Responsible Use Guide available available at https://ai.meta.com/llama/responsible-user-guide.