library_name: transformers
license: gemma
license_link: https://ai.google.dev/gemma/terms
extra_gated_heading: Access CodeGemma on Hugging Face
extra_gated_prompt: To access CodeGemma on Hugging Face, you’re required to review
and agree to Google’s usage license. To do this, please ensure you’re logged-in
to Hugging Face and click below. Requests are processed immediately.
extra_gated_button_content: Acknowledge license
Summary description and brief definition of inputs and outputs.
Description
CodeGemma is a collection of lightweight open code models built on top of Gemma. CodeGemma models are text-to-text and text-to-code decoder-only models and are available as a 7 billion pretrained variant that specializes in code completion and code generation tasks, a 7 billion parameter instruction-tuned variant for code chat and instruction following and a 2 billion parameter pretrained variant for fast code completion.
Code completion can be used for infilling inside code editors. CodeGemma was trained for this task using the fill-in-the-middle (FIM) objective, where you provide a prefix and a suffix as context for the completion. The following tokens are used to separate the different parts of the input:
<|fim_prefix|> precedes the context before the completion we want to run.
<|fim_suffix|> precedes the suffix. You must put this token exactly where the cursor would be positioned in an editor, as this is the location that will be completed by the model.
<|fim_middle|> is the prompt that invites the model to run the generation.
In addition to these, there's also <|file_separator|>, which is used to provide multi-file contexts.
Please, make sure to not provide any extra spaces or newlines around the tokens, other than those that would naturally occur in the code fragment you want to complete. Here's an example:
python
1from transformers import GemmaTokenizer, AutoModelForCausalLM
23model_id ="google/codegemma-2b"4tokenizer = GemmaTokenizer.from_pretrained(model_id)5model = AutoModelForCausalLM.from_pretrained(model_id)67prompt ='''\
8<|fim_prefix|>import datetime
9def calculate_age(birth_year):
10 """Calculates a person's age based on their birth year."""
11 current_year = datetime.date.today().year
12 <|fim_suffix|>
13 return age<|fim_middle|>\
14'''1516inputs = tokenizer(prompt, return_tensors="pt").to(model.device)17prompt_len = inputs["input_ids"].shape[-1]18outputs = model.generate(**inputs, max_new_tokens=100)19print(tokenizer.decode(outputs[0][prompt_len:]))
Note the extra content after the correct completion. The model returns the completion, followed by one of the FIM tokens or the EOS token. You should ignore everything that comes after any of these tokens. A good way to achieve this is by providing a list of terminators to the generate function, like this:
In this case, generation stops as soon as the first delimiter is found in the response:
age = current_year - birth_year<|file_separator|>
For Code Generation
python
1from transformers import GemmaTokenizer, AutoModelForCausalLM
23tokenizer = GemmaTokenizer.from_pretrained("google/codegemma-2b")4model = AutoModelForCausalLM.from_pretrained("google/codegemma-2b")56input_text ="Write me a Python function to calculate the nth fibonacci number."7input_ids = tokenizer(input_text, return_tensors="pt")89outputs = model.generate(**input_ids)10print(tokenizer.decode(outputs[0]))
Inputs and Outputs
Inputs
: For pretrained model variants: code prefix and/or suffix for code completion and generation scenarios, or natural language text or prompt
: For instruction tuned model variant: natural language text or prompt
Outputs
: For pretrained model variants: fill-in-the-middle code completion, code and natural language
: For instruction tuned model variant: code and natural language
Model Data
Data used for model training and how the data was processed.
Training Dataset
Using Gemma as the base model, CodeGemma 2B and 7B pretrained variants are further trained on an additional 500 billion tokens of primarily English language data from publicly available code repositories, open source mathematics datasets and synthetically generated code.
Training Data Processing
The following data pre-processing techniques were applied:
FIM Pretrained CodeGemma models focus on fill-in-the-middle (FIM) tasks. The models are trained to work with both PSM and SPM modes. Our FIM settings are 80% FIM rate with 50-50 PSM/SPM.
Dependency Graph-based Packing and Unit Test-based Lexical Packing techniques: To improve model alignment with real-world applications, we structured training examples at the project/repository level to co-locate the most relevant source files within each repository. Specifically, we employed two heuristic techniques: dependency graph-based packing and unit test-based lexical packing
We developed a novel technique for splitting the documents into prefix, middle, and suffix to make the suffix start in a more syntactically natural point rather than purely random distribution.
Safety: Similarly to Gemma, we deployed rigorous safety filtering including filtering personal data, CSAM filtering and other filtering based on content quality and safety in line with our policies.
Implementation Information
Information about the hardware and software used to train the models.
Ethics and safety evaluation approach and results.
Evaluation Approach
Our evaluation methods include structured evaluations and internal red-teaming testing of relevant content policies. Red-teaming was conducted by a number of different teams, each with different goals and human evaluation metrics. These models were evaluated against a number of different categories relevant to ethics and safety, including:
Human evaluation on prompts covering content safety and representational harms. See the Gemma model card for more details on evaluation approach.
Specific testing of cyber-offence capabilities, focusing on testing autonomous hacking capabilities and ensuring potential harms are limited.
Evaluation Results
The results of ethics and safety evaluations are within acceptable thresholds for meeting internal policies for categories such as child safety, content safety, representational harms, memorization, large-scale harms. See the Gemma model card for more details.
Model Usage & Limitations
These models have certain limitations that users should be aware of.
Intended Usage
Code Gemma models have a wide range of applications, which vary between IT and PT models. The following list of potential uses is not comprehensive. The purpose of this list is to provide contextual information about the possible use-cases that the model creators considered as part of model training and development.
Code Completion
: PT models can be used to complete code with an IDE extension
Code Generation
: IT model can be used to generate code with or without an IDE extension
Code Conversation
: IT model can power conversation interfaces which discuss code.
Code Education
: IT model supports interactive code learning experiences, aids in syntax correction or provides coding practice.
Known Limitations
Large Language Models (LLMs) have limitations based on their training data and the inherent limitations of the technology. See the Gemma model card for more details on the limitations of LLMs.
Ethical Considerations & Risks
The development of large language models (LLMs) raises several ethical concerns. We have carefully considered multiple aspects in the development of these models. Please refer to the same discussion in the Gemma model card for model details.
Benefits
At the time of release, this family of models provides high-performance open code-focused large language model implementations designed from the ground up for Responsible AI development compared to similarly sized models.
Using the coding benchmark evaluation metrics described in this document, these models have shown to provide superior performance to other, comparably-sized open model alternatives.
