Ruler97 commited on
Commit
d5b3e06
·
verified ·
1 Parent(s): 16f50e3

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -9
README.md CHANGED
@@ -17,9 +17,9 @@ language:
17
  pipeline_tag: text-generation
18
  ---
19
 
20
- # 🎮 Godoter — a Qwen3.6-27B fine-tune for Godot 4 & GDScript
21
 
22
- > ⚠️ **Unofficial hobby project — NOT made by Godot.** Godoter is a personal, non-commercial fine-tune made by an independent hobbyist for fun and learning. It is **not made, created, maintained, affiliated with, sponsored by, or endorsed by the Godot Foundation or the Godot Engine team**. *"Godot"* is a trademark of the Godot Foundation, used here only to describe what the model is for. Training data includes the official **Godot documentation (CC-BY 4.0)**; the base model is **Qwen3.6-27B** (Apache 2.0).
23
 
24
  **Godoter** is a 27-billion-parameter model specialized in writing **Godot 4 / GDScript**.
25
  It is a QLoRA fine-tune of **Qwen3.6-27B**, with the adapter merged back into the base
@@ -32,14 +32,14 @@ weights so it loads as a normal model.
32
 
33
  ---
34
 
35
- ##What it's good at
36
 
37
  - Writing idiomatic **Godot 4** GDScript (nodes, signals, resources, `@export`/`@onready`, `await`, typed code).
38
  - Building **complete, multi-file systems**: inventory, finite-state-machine AI, save/load, dialogue, multiplayer, shaders, combat (hitbox/hurtbox), navigation, crafting, skill trees, and more.
39
  - **Not** confusing Godot 3 and Godot 4 APIs (`move_and_slide()`, `instantiate()`, `CharacterBody2D/3D`, `source_color`, `FileAccess`, signal `.connect()`/`.emit()`, `@rpc`, …).
40
  - Staying in Godot instead of drifting to Unity, Python, web, or other frameworks.
41
 
42
- ## 📊 Benchmark
43
 
44
  Godoter vs. the base **Qwen3.6-27B**, both in the same **Q6_K** quant, same GPU, same prompts,
45
  thinking enabled for both. A task "passes" only if the answer uses the correct **Godot 4** API
@@ -63,7 +63,7 @@ On the **hard set**, reading the actual answers shows *why* the base struggles:
63
  (The 68% even *overstates* the base, since the keyword rubric credits wrong-language or
64
  incomplete answers. The real gap is larger.)
65
 
66
- ## 🧠 How it was trained
67
 
68
  - **Base model:** `unsloth/Qwen3.6-27B`
69
  - **Method:** QLoRA, rank `r = 16`, `alpha = 16`, `adamw_8bit`, 4-bit base — adapter then merged to 16-bit.
@@ -73,7 +73,7 @@ incomplete answers. The real gap is larger.)
73
  - **666 complete, multi-file Godot 4 systems** authored as build / explain / extend triples
74
  - real Godot 4 GDScript completion pairs
75
 
76
- ## 🚀 Usage
77
 
78
  This is a `qwen3_5` / Qwen3.6 architecture model — it needs **transformers 5.x**.
79
 
@@ -91,10 +91,10 @@ out = model.generate(ids, max_new_tokens=512)
91
  print(tok.decode(out[0][ids.shape[1]:], skip_special_tokens=True))
92
  ```
93
 
94
- 💡 **For local use, prefer the GGUF builds** (LM Studio / llama.cpp / Ollama):
95
  **[Ruler97/Godoter-27B-GGUF](https://huggingface.co/Ruler97/Godoter-27B-GGUF)** (Q4 / Q6 / Q8).
96
 
97
- ## ⚠️ Limitations
98
 
99
  - It's a **derivative of Qwen3.6-27B** — ~99% of its capability is the base model; the
100
  fine-tune adds Godot-4 reliability, not new general reasoning.
@@ -103,7 +103,7 @@ print(tok.decode(out[0][ids.shape[1]:], skip_special_tokens=True))
103
  - The benchmark measures **API correctness**, not full architectural quality of generated code.
104
  - Like any LLM, it can be confidently wrong — review generated code before shipping.
105
 
106
- ## 📜 License & attribution
107
 
108
  Godoter is a fine-tune of **Qwen3.6-27B**, which is licensed **Apache 2.0**, and Godoter is
109
  released under **Apache 2.0** as well. Please keep attribution to the base model. Built with Unsloth.
 
17
  pipeline_tag: text-generation
18
  ---
19
 
20
+ # Godoter — a Qwen3.6-27B fine-tune for Godot 4 & GDScript
21
 
22
+ > **Unofficial hobby project — NOT made by Godot.** Godoter is a personal, non-commercial fine-tune made by an independent hobbyist for fun and learning. It is **not made, created, maintained, affiliated with, sponsored by, or endorsed by the Godot Foundation or the Godot Engine team**. *"Godot"* is a trademark of the Godot Foundation, used here only to describe what the model is for. Training data includes the official **Godot documentation (CC-BY 4.0)**; the base model is **Qwen3.6-27B** (Apache 2.0).
23
 
24
  **Godoter** is a 27-billion-parameter model specialized in writing **Godot 4 / GDScript**.
25
  It is a QLoRA fine-tune of **Qwen3.6-27B**, with the adapter merged back into the base
 
32
 
33
  ---
34
 
35
+ ## What it's good at
36
 
37
  - Writing idiomatic **Godot 4** GDScript (nodes, signals, resources, `@export`/`@onready`, `await`, typed code).
38
  - Building **complete, multi-file systems**: inventory, finite-state-machine AI, save/load, dialogue, multiplayer, shaders, combat (hitbox/hurtbox), navigation, crafting, skill trees, and more.
39
  - **Not** confusing Godot 3 and Godot 4 APIs (`move_and_slide()`, `instantiate()`, `CharacterBody2D/3D`, `source_color`, `FileAccess`, signal `.connect()`/`.emit()`, `@rpc`, …).
40
  - Staying in Godot instead of drifting to Unity, Python, web, or other frameworks.
41
 
42
+ ## Benchmark
43
 
44
  Godoter vs. the base **Qwen3.6-27B**, both in the same **Q6_K** quant, same GPU, same prompts,
45
  thinking enabled for both. A task "passes" only if the answer uses the correct **Godot 4** API
 
63
  (The 68% even *overstates* the base, since the keyword rubric credits wrong-language or
64
  incomplete answers. The real gap is larger.)
65
 
66
+ ## How it was trained
67
 
68
  - **Base model:** `unsloth/Qwen3.6-27B`
69
  - **Method:** QLoRA, rank `r = 16`, `alpha = 16`, `adamw_8bit`, 4-bit base — adapter then merged to 16-bit.
 
73
  - **666 complete, multi-file Godot 4 systems** authored as build / explain / extend triples
74
  - real Godot 4 GDScript completion pairs
75
 
76
+ ## Usage
77
 
78
  This is a `qwen3_5` / Qwen3.6 architecture model — it needs **transformers 5.x**.
79
 
 
91
  print(tok.decode(out[0][ids.shape[1]:], skip_special_tokens=True))
92
  ```
93
 
94
+ **For local use, prefer the GGUF builds** (LM Studio / llama.cpp / Ollama):
95
  **[Ruler97/Godoter-27B-GGUF](https://huggingface.co/Ruler97/Godoter-27B-GGUF)** (Q4 / Q6 / Q8).
96
 
97
+ ## Limitations
98
 
99
  - It's a **derivative of Qwen3.6-27B** — ~99% of its capability is the base model; the
100
  fine-tune adds Godot-4 reliability, not new general reasoning.
 
103
  - The benchmark measures **API correctness**, not full architectural quality of generated code.
104
  - Like any LLM, it can be confidently wrong — review generated code before shipping.
105
 
106
+ ## License & attribution
107
 
108
  Godoter is a fine-tune of **Qwen3.6-27B**, which is licensed **Apache 2.0**, and Godoter is
109
  released under **Apache 2.0** as well. Please keep attribution to the base model. Built with Unsloth.