Update README.md

README.md

@@ -9,7 +9,7 @@ metrics:
 - code_eval
 library_name: transformers
 model-index:
-- name: stabilityai/stable-code-instruct-3b
+- name: dgtalbug/stable-code-instruct-3b
   results:
   - task:
       type: text-generation
@@ -20,7 +20,6 @@ model-index:
     - name: pass@1
       type: pass@1
       value: 32.4
-      verified: false
   - task:
       type: text-generation
     dataset:
@@ -30,7 +29,6 @@ model-index:
     - name: pass@1
       type: pass@1
       value: 30.9
-      verified: false
   - task:
       type: text-generation
     dataset:
@@ -40,7 +38,6 @@ model-index:
     - name: pass@1
       type: pass@1
       value: 32.1
-      verified: false
   - task:
       type: text-generation
     dataset:
@@ -50,7 +47,6 @@ model-index:
     - name: pass@1
       type: pass@1
       value: 32.1
-      verified: false
   - task:
       type: text-generation
     dataset:
@@ -60,7 +56,6 @@ model-index:
     - name: pass@1
       type: pass@1
       value: 24.2
-      verified: false
   - task:
       type: text-generation
     dataset:
@@ -70,56 +65,64 @@ model-index:
     - name: pass@1
       type: pass@1
       value: 23.0
-      verified: false
 ---
-# **Stable Code Instruct 3B**
 
-[Try it out here: https://huggingface.co/spaces/stabilityai/stable-code-instruct-3b](https://huggingface.co/spaces/stabilityai/stable-code-instruct-3b)
+# **Stable Code Instruct 3B — Base Model**
 
-![image/png](https://cdn-uploads.huggingface.co/production/uploads/63466107f7bd6326925fc770/O7ZkLgqoJprQEWAttX7Hj.png)
+> This repository stores an **unchanged** copy of `stabilityai/stable-code-instruct-3b`  
+> for use as a **base model** in future fine‑tuning projects (including Stephen).
 
-## Model Description
+---
 
-`stable-code-instruct-3b` is a 2.7B billion parameter decoder-only language model tuned from [`stable-code-3b`](https://huggingface.co/stabilityai/stable-code-3b/). This model was trained on a mix of publicly available datasets, synthetic datasets using [Direct Preference Optimization (DPO)](https://arxiv.org/abs/2305.18290). 
+## 📌 About the Model
 
-This instruct tune demonstrates state-of-the-art performance (compared to models of similar size) on the MultiPL-E metrics across multiple programming languages tested using [BigCode's Evaluation Harness](https://github.com/bigcode-project/bigcode-evaluation-harness/tree/main), and on the code portions of
-[MT Bench](https://klu.ai/glossary/mt-bench-eval).
-The model is finetuned to make it useable in tasks like,
-  - General purpose Code/Software Engineering like conversations.
-  - SQL related generation and conversation.
+`stable-code-instruct-3b` is a **2.7B parameter decoder-only transformer** from Stability AI, tuned for multi‑language code generation and conversational coding assistance.  
+It is suitable as a **starting point** for specialized code assistants,  
+including fine‑tuned variants with domain‑specific datasets.
 
-Please note: For commercial use, please refer to https://stability.ai/license.
+**Key Features:**
+- General purpose code generation across multiple programming languages.
+- Instruction‑tuned for better conversational performance.
+- Strong performance on [MultiPL-E](https://github.com/nuprl/MultiPL-E) benchmarks.
 
-## Usage
-Here's how you can run the model use the model:
+---
 
-```python
+## 📊 Performance (MultiPL-E Benchmark)
 
+| Language     | pass@1 |
+|--------------|--------|
+| Python       | 32.4%  |
+| C++          | 30.9%  |
+| Java         | 32.1%  |
+| JavaScript   | 32.1%  |
+| PHP          | 24.2%  |
+| Rust         | 23.0%  |
+
+---
+
+## 🚀 Usage
+
+```python
 import torch
 from transformers import AutoModelForCausalLM, AutoTokenizer
-tokenizer = AutoTokenizer.from_pretrained("stabilityai/stable-code-instruct-3b", trust_remote_code=True)
-model = AutoModelForCausalLM.from_pretrained("stabilityai/stable-code-instruct-3b", torch_dtype=torch.bfloat16, trust_remote_code=True)
-model.eval()
-model = model.cuda()
+
+model_id = "dgtalbug/stable-code-instruct-3b"
+tokenizer = AutoTokenizer.from_pretrained(model_id, trust_remote_code=True)
+model = AutoModelForCausalLM.from_pretrained(
+    model_id, torch_dtype=torch.bfloat16, trust_remote_code=True
+).cuda().eval()
 
 messages = [
-    {
-        "role": "system",
-        "content": "You are a helpful and polite assistant",
-    },
-    {
-        "role": "user",
-        "content": "Write a simple website in HTML. When a user clicks the button, it shows a random joke from a list of 4 jokes."
-    },
+    {"role": "system", "content": "You are a helpful coding assistant."},
+    {"role": "user", "content": "Write a Python function to reverse a string."}
 ]
 
 prompt = tokenizer.apply_chat_template(messages, add_generation_prompt=True, tokenize=False)
-
 inputs = tokenizer([prompt], return_tensors="pt").to(model.device)
 
 tokens = model.generate(
     **inputs,
-    max_new_tokens=1024,
+    max_new_tokens=200,
     temperature=0.5,
     top_p=0.95,
     top_k=100,
@@ -127,56 +130,20 @@ tokens = model.generate(
     use_cache=True
 )
 
-output = tokenizer.batch_decode(tokens[:, inputs.input_ids.shape[-1]:], skip_special_tokens=False)[0]
+output = tokenizer.batch_decode(tokens[:, inputs.input_ids.shape[-1]:], skip_special_tokens=True)[0]
+print(output)
 ```
 
-## Model Details
-
-* **Developed by**: [Stability AI](https://stability.ai/)
-* **Model type**: `Stable Code Instruct 3B` model is an auto-regressive language model based on the transformer decoder architecture.
-* **Language(s)**: English
-* **Paper**: [Stable Code Technical Report](https://drive.google.com/file/d/16-DGsR5-qwoPztZ6HcM7KSRUxIXrjlSm/view)
-* **Library**: [Alignment Handbook](https://github.com/huggingface/alignment-handbook.git)
-* **Finetuned from model**: [https://huggingface.co/stabilityai/stable-code-3b](https://huggingface.co/stabilityai/stable-code-3b)
-* **License**: [StabilityAI Community License](https://huggingface.co/stabilityai/stable-code-instruct-3b/blob/main/LICENSE.md).
-* **Commercial License**: to use this model commercially, please refer to https://stability.ai/license
-* **Contact**: For questions and comments about the model, please email `[email protected]`
-
-
-## Performance
-### Multi-PL Benchmark:
-| Model                        | Size | Avg  | Python | C++  | JavaScript | Java | PHP  | Rust |
-|------------------------------|------|------|--------|------|------------|------|------|------|
-| Codellama Instruct           | 7B   | 0.30 | 0.33   | 0.31 | 0.31       | 0.29 | 0.31 | 0.25 |
-| Deepseek Instruct            | 1.3B | 0.44 | 0.52   | **0.52** | 0.41       | **0.46** | 0.45 | 0.28 |
-| Stable Code Instruct (SFT)   | 3B   | 0.44 | 0.55   | 0.45 | 0.42       | 0.42 | 0.44 | 0.32 |
-| Stable Code Instruct (DPO)   | 3B   | **0.47** | **0.59**   | 0.49 | **0.49**       | 0.44 | **0.45** | **0.37** |
-
-### MT-Bench Coding:
-| Model                       | Size | Score |
-|-----------------------------|------|-----------------|
-| DeepSeek Coder              | 1.3B | 4.6             |
-| Stable Code Instruct (DPO)  | 3B   | **5.8**(ours)             |
-| Stable Code Instruct (SFT)  | 3B   | 5.5             |
-| DeepSeek Coder              | 6.7B | **6.9**             |
-| CodeLlama Instruct          | 7B   | 3.55            |
-| StarChat2                   | 15B  | 5.7             |
-
-### SQL Performance
-| Model                       | Size | Date  | Group By | Order By | Ratio | Join  | Where |
-|-----------------------------|------|-------|----------|----------|-------|-------|-------|
-| Stable Code Instruct (DPO)  | 3B   | 24.0% | 54.2%    | 68.5%    | 40.0% | 54.2% | 42.8% |
-| DeepSeek-Coder Instruct     | 1.3B | 24.0% | 37.1%    | 51.4%    | 34.3% | 45.7% | 45.7% |
-| SQLCoder                    | 7B   | 64.0% | 82.9%    | 74.3%    | 54.3% | 74.3% | 74.3% |
-
-
-
-
-## How to Cite
-```bibtex
-@misc{stable-code-instruct-3b,
-      url={[https://huggingface.co/stabilityai/stable-code-3b](https://huggingface.co/stabilityai/stable-code-instruct-3b)},
-      title={Stable Code 3B},
-      author={Phung, Duy, and Pinnaparaju, Nikhil and Adithyan, Reshinth and Zhuravinskyi, Maksym and Tow, Jonathan and Cooper, Nathan}
-}
-```
+---
+
+## 📜 License
+
+This model follows the **[Stability AI Community License](https://huggingface.co/stabilityai/stable-code-instruct-3b/blob/main/LICENSE.md)**.  
+For commercial use, refer to [Stability AI licensing terms](https://stability.ai/license).
+
+---
+
+## 📌 Note for Fine‑Tuning
+
+This repository is **not modified** — it is kept as a **clean base model** for derivative works.  
+Fine‑tuned versions (e.g., Stephen) will be released in **separate repositories**.