JBHarris commited on
Commit
6fbc64b
·
verified ·
1 Parent(s): c065bef

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +65 -65
README.md CHANGED
@@ -1,65 +1,65 @@
1
- ---
2
- language:
3
- - en
4
- license: apache-2.0
5
- library_name: transformers
6
- tags:
7
- - dnd
8
- - dungeons-and-dragons
9
- - rpg
10
- - text-generation
11
- - qlora
12
- - tinyllama
13
- base_model: TinyLlama/TinyLlama-1.1B-Chat-v1.0
14
- pipeline_tag: text-generation
15
- ---
16
-
17
- # DM-LLM-Tiny
18
-
19
- A tiny (1.1B parameter) language model fine-tuned for **Dungeons & Dragons** content generation.
20
-
21
- ## What it does
22
-
23
- Generates creative D&D content including:
24
- - **NPCs** — memorable characters with backstories, motivations, and quirks
25
- - **Quests** — hooks, outlines, and full quest arcs
26
- - **Dialog** — in-character conversations, monologues, and banter
27
- - **Locations** — vivid descriptions of dungeons, towns, and wilderness
28
- - **Encounters** — combat, social, and puzzle encounters
29
-
30
- ## Usage
31
-
32
- ### With Ollama (easiest)
33
- ```bash
34
- ollama run JBHarris/dm-llm-tiny
35
- ```
36
-
37
- ### With Transformers
38
- ```python
39
- from transformers import pipeline
40
-
41
- pipe = pipeline("text-generation", model="JBHarris/dm-llm-tiny")
42
- messages = [
43
- {"role": "system", "content": "You are a creative D&D dungeon master's assistant."},
44
- {"role": "user", "content": "Create a mysterious NPC for a tavern scene."},
45
- ]
46
- result = pipe(messages, max_new_tokens=512)
47
- print(result[0]["generated_text"][-1]["content"])
48
- ```
49
-
50
- ## Training
51
-
52
- - **Base model:** TinyLlama-1.1B-Chat-v1.0
53
- - **Method:** QLoRA (4-bit NF4 quantization + LoRA r=64)
54
- - **Data:** ~500 synthetic D&D instruction/response pairs generated with Claude
55
- - **Hardware:** NVIDIA RTX 4080 16GB
56
-
57
- ## Limitations
58
-
59
- This is a 1.1B parameter model. It's creative and fun for brainstorming but will not match
60
- the quality of larger models (7B+). Best used as a quick idea generator, not a replacement
61
- for a human DM's judgment.
62
-
63
- ## License
64
-
65
- Apache 2.0 (same as base model)
 
1
+ ---
2
+ language:
3
+ - en
4
+ license: apache-2.0
5
+ library_name: transformers
6
+ tags:
7
+ - dnd
8
+ - dungeons-and-dragons
9
+ - rpg
10
+ - text-generation
11
+ - qlora
12
+ - tinyllama
13
+ base_model: TinyLlama/TinyLlama-1.1B-Chat-v1.0
14
+ pipeline_tag: text-generation
15
+ ---
16
+
17
+ # DM-LLM-Tiny
18
+
19
+ A tiny (1.1B parameter) language model fine-tuned for **Dungeons & Dragons** content generation.
20
+
21
+ ## What it does
22
+
23
+ Generates creative D&D content including:
24
+ - **NPCs** — memorable characters with backstories, motivations, and quirks
25
+ - **Quests** — hooks, outlines, and full quest arcs
26
+ - **Dialog** — in-character conversations, monologues, and banter
27
+ - **Locations** — vivid descriptions of dungeons, towns, and wilderness
28
+ - **Encounters** — combat, social, and puzzle encounters
29
+
30
+ ## Usage
31
+
32
+ ### With Ollama (easiest)
33
+ ```bash
34
+ ollama run JBHarris/dm-llm-tiny
35
+ ```
36
+
37
+ ### With Transformers
38
+ ```python
39
+ from transformers import pipeline
40
+
41
+ pipe = pipeline("text-generation", model="JBHarris/dm-llm-tiny")
42
+ messages = [
43
+ {"role": "system", "content": "You are a creative D&D dungeon master's assistant."},
44
+ {"role": "user", "content": "Create a mysterious NPC for a tavern scene."},
45
+ ]
46
+ result = pipe(messages, max_new_tokens=512)
47
+ print(result[0]["generated_text"][-1]["content"])
48
+ ```
49
+
50
+ ## Training
51
+
52
+ - **Base model:** TinyLlama-1.1B-Chat-v1.0
53
+ - **Method:** QLoRA (4-bit NF4 quantization + LoRA r=64)
54
+ - **Data:** ~5000 synthetic D&D instruction/response pairs generated with Claude
55
+ - **Hardware:** NVIDIA RTX 4080 16GB
56
+
57
+ ## Limitations
58
+
59
+ This is a 1.1B parameter model. It's creative and fun for brainstorming but will not match
60
+ the quality of larger models (7B+). Best used as a quick idea generator, not a replacement
61
+ for a human DM's judgment.
62
+
63
+ ## License
64
+
65
+ Apache 2.0 (same as base model)