theguywhosucks commited on
Commit
46fbf15
Β·
verified Β·
1 Parent(s): d276912

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +97 -1
README.md CHANGED
@@ -5,4 +5,100 @@ license_link: LICENSE
5
  base_model:
6
  - theguywhosucks/mochaV1-base
7
  pipeline_tag: text-generation
8
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5
  base_model:
6
  - theguywhosucks/mochaV1-base
7
  pipeline_tag: text-generation
8
+ ---
9
+ # Mocha Mini β˜•
10
+
11
+ Mocha Mini is a **tiny but mighty sentence completion model** designed for **fast, creative text generation** without the bloat. Perfect for small projects, prototyping, or just having fun with text.
12
+
13
+ <p align="center">
14
+ <img src="./banner.png" alt="Mocha Mini Banner" width="600"/>
15
+ </p>
16
+
17
+ ---
18
+
19
+ ## ⚑ Features
20
+
21
+ * 🏎 **Ultra-Lightweight** – fast loading, easy deployment.
22
+ * ✍️ **Sentence Completion** – generate relevant endings from any text prompt.
23
+ * πŸ›‘ **Safetensors Format** – secure, efficient, and easy to load.
24
+ * 🎨 **Custom Tokenization** – uses `stoi`/`itos` for fully local control.
25
+
26
+ ---
27
+
28
+ ## πŸ“‚ Project Structure
29
+
30
+ ```
31
+ .
32
+ β”œβ”€β”€ mocha.safetensors # Model weights
33
+ β”œβ”€β”€ config.json
34
+ β”œβ”€β”€ generation_config.json
35
+ β”œβ”€β”€ itos.json # Index-to-string mapping
36
+ β”œβ”€β”€ stoi.json # String-to-index mapping
37
+ β”œβ”€β”€ logo.png # Project logo
38
+ β”œβ”€β”€ banner.png # Project banner
39
+ └── README.md
40
+ ```
41
+
42
+ ---
43
+
44
+ ## πŸš€ Quick Start
45
+
46
+ No official tokenizer? No problem β€” Mocha Mini just needs your `stoi`/`itos` for input/output mapping:
47
+
48
+ ```python
49
+ import torch
50
+ from transformers import AutoModelForCausalLM, AutoConfig
51
+
52
+ # Load config and model
53
+ config = AutoConfig.from_pretrained("theguywhosucks/mochaV1-base", trust_remote_code=True)
54
+ model = AutoModelForCausalLM.from_pretrained(
55
+ "theguywhosucks/mochaV1-base",
56
+ config=config,
57
+ device_map="auto",
58
+ load_in_8bit=True, # INT8 quantization for speed & memory
59
+ trust_remote_code=True,
60
+ use_safetensors=True
61
+ )
62
+
63
+ # Use your custom stoi/itos for input/output
64
+ def stoi(text): ...
65
+ def tosi(indices): ...
66
+
67
+ prompt = "The future of AI is"
68
+ tokens = stoi(prompt)
69
+ # Model inference logic here
70
+ ```
71
+
72
+ ---
73
+
74
+ ## πŸ“Έ Assets
75
+
76
+ <p align="center">
77
+ <img src="./logo.png" alt="Mocha Mini Logo" width="120"/>
78
+ </p>
79
+
80
+ ---
81
+
82
+ ## πŸ›  Requirements
83
+
84
+ * Python 3.9+
85
+ * [Transformers](https://pypi.org/project/transformers/)
86
+ * [Safetensors](https://pypi.org/project/safetensors/)
87
+ * [PyTorch](https://pytorch.org/)
88
+ * [bitsandbytes](https://pypi.org/project/bitsandbytes/) (optional for INT8 quantization)
89
+
90
+ Install all dependencies:
91
+
92
+ ```bash
93
+ pip install torch transformers safetensors bitsandbytes
94
+ ```
95
+
96
+ ---
97
+
98
+ ## πŸ“œ License
99
+
100
+ Licensed under the **Mocha Proprietary License** β€” usage, distribution, and modification are restricted. See [LICENSE](./LICENSE) for details.
101
+
102
+ ---
103
+
104
+ β˜• **Mocha Mini** – tiny, fast, and ready to complete your sentences.