BurakColakkadioglu commited on
Commit
5531504
·
verified ·
1 Parent(s): 8eb40f9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +85 -0
README.md CHANGED
@@ -1,3 +1,88 @@
1
  ---
2
  license: apache-2.0
 
 
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
+ language:
4
+ - en
5
+ pipeline_tag: text-generation
6
+ tags:
7
+ - roleplay
8
+ - creative-writing
9
+ - local-llm
10
+ - cpu-inference
11
+ library_name: transformers
12
  ---
13
+
14
+ # Roleshade 230M
15
+
16
+ **Status: 🚧 Weights pending release — expected in 2–3 weeks.**
17
+
18
+ Roleshade 230M is a 230-million-parameter model built by [Lightshade](https://new.lightshade.cloud) for **roleplay and creative writing**. It is designed to run well on hardware people actually own — phones, laptops, and CPU-only machines — without giving up long-context conversations.
19
+
20
+ This repository is a placeholder. Model files, quantizations, and usage examples will be published here on release.
21
+
22
+ ---
23
+
24
+ ## Highlights
25
+
26
+ - **Purpose-built for character work.** Trained for persona consistency, scene memory, and prose that resists the repetition collapse common at this parameter count.
27
+ - **Fast prefill on CPUs and phones.** Roleshade 230M uses a custom architecture that addresses the prefill bottleneck that makes long-context local models painful on non-GPU hardware. Loading a long chat history doesn't mean waiting on a spinner.
28
+ - **Long context, anywhere.** Deep, persistent roleplay sessions on a laptop, desktop, or phone.
29
+ - **Extremely lightweight.** At 230M parameters, this is Lightshade's smallest Roleshade variant — built for devices where even 1B-class models are too heavy.
30
+ - **Local by default.** Runs entirely on your own machine. Nothing leaves the device.
31
+
32
+ ---
33
+
34
+ ## Intended Use
35
+
36
+ **Primary:** Interactive roleplay, character simulation, collaborative fiction, and creative writing assistance on constrained hardware.
37
+
38
+ **Out of scope:** Factual question answering, coding assistance, math, retrieval-grounded work, safety-critical applications, or any use where the model's output is treated as authoritative. Roleshade 230M is a creative model and will confidently produce fiction.
39
+
40
+ ---
41
+
42
+ ## Usage
43
+
44
+ Code samples will be added when weights are published.
45
+
46
+ ```python
47
+ # Available on release
48
+ from transformers import AutoModelForCausalLM, AutoTokenizer
49
+
50
+ model_id = "lightshade/roleshade-230m"
51
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
52
+ model = AutoModelForCausalLM.from_pretrained(model_id)
53
+ ```
54
+
55
+ Roleshade 230M will also be available directly on **LSAI** at launch — one click, no setup required.
56
+
57
+ Recommended sampler settings and prompt/character-card formatting will be documented here at release.
58
+
59
+ ---
60
+
61
+ ## Limitations
62
+
63
+ - At 230M parameters, world knowledge is very limited. Expect confident hallucination on factual topics, more so than larger Roleshade variants.
64
+ - Optimized for creative output; general instruction-following outside of roleplay contexts should not be expected to be strong.
65
+ - Long-session coherence is solid for the size class but not unlimited, and simpler than larger models on complex, multi-thread scenes.
66
+ - English-first. Other languages are untested.
67
+ - Best suited for lightweight, casual roleplay rather than nuanced or highly demanding creative writing tasks — for those, consider a larger Roleshade variant.
68
+
69
+ ## Responsible Use
70
+
71
+ This model is intended for adult creative fiction and roleplay. Users are responsible for how they deploy it and for complying with applicable law and the terms of any platform they run it on. Outputs are fiction and should not be relied on as advice of any kind.
72
+
73
+ ---
74
+
75
+ ## License
76
+
77
+ Apache 2.0 (subject to confirmation at release).
78
+
79
+ ## Citation
80
+
81
+ ```bibtex
82
+ @misc{roleshade230m,
83
+ title = {Roleshade 230M},
84
+ author = {Lightshade},
85
+ year = {2026},
86
+ url = {https://huggingface.co/LightshadeML/Roleshade-230M}
87
+ }
88
+ ```