Upload README.md

README.md

@@ -1,5 +1,45 @@
 ---
+tags:
+- code
+- gemma
+library_name: transformers
+pipeline_tag: text-generation
 license: other
 license_name: gemma-terms-of-use
 license_link: https://ai.google.dev/gemma/terms
 ---
+
+<p align="center">
+<img width="300px" alt="CodeGemma" src="https://huggingface.co/TechxGenus/CodeGemma-2b/resolve/main/CodeGemma.jpg">
+</p>
+
+### CodeGemma
+
+We've fine-tuned Gemma-2b with an additional 0.7 billion high-quality, code-related tokens for 3 epochs. We used DeepSpeed ZeRO 3 and Flash Attention 2 to accelerate the training process. It achieves **54.9 pass@1** on HumanEval-Python. This model operates using the Alpaca instruction format (excluding the system prompt).
+
+### Usage
+
+Here give an example of how to use our model.
+
+```python
+from transformers import pipeline
+import torch
+PROMPT = """### Instruction
+{instruction}
+### Response
+"""
+instruction = <Your code instruction here>
+prompt = PROMPT.format(instruction=instruction)
+generator = pipeline(
+    model="TechxGenus/CodeGemma-2b",
+    task="text-generation",
+    torch_dtype=torch.bfloat16,
+    device_map="auto",
+)
+result = generator(prompt, max_length=2048)
+print(result[0]["generated_text"])
+```
+
+### Note
+
+Model may sometimes make errors, produce misleading contents, or struggle to manage tasks that are not related to coding. It has undergone very limited testing. Additional safety testing should be performed before any real-world deployments.