Commit
·
95dc308
1
Parent(s):
5a62cd2
docs(readme): update documentation with new installation steps
Browse files- Add detailed environment setup instructions
- Include troubleshooting section for common issues
- Update compatibility matrix for latest dependencies
README.md
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Shoonya v0.1 - Lightweight CPU-Friendly Language Model
|
| 2 |
+
|
| 3 |
+
## Model Description
|
| 4 |
+
Shoonya is a lightweight transformer-based language model designed specifically for CPU inference. Built with efficiency in mind, it features a compact architecture while maintaining coherent text generation capabilities.
|
| 5 |
+
|
| 6 |
+
## Key Features
|
| 7 |
+
- **CPU-Optimized**: Designed to run efficiently on CPU-only environments
|
| 8 |
+
- **Lightweight**: Only 4 transformer layers with 128 hidden dimensions
|
| 9 |
+
- **Memory Efficient**: ~15MB model size (quantized version ~4MB)
|
| 10 |
+
- **Fast Inference**: Suitable for real-time text generation on consumer hardware
|
| 11 |
+
|
| 12 |
+
## Technical Details
|
| 13 |
+
- **Architecture**: Transformer-based language model
|
| 14 |
+
- 4 attention layers
|
| 15 |
+
- 4 attention heads per layer
|
| 16 |
+
- 128 hidden dimensions
|
| 17 |
+
- 256 intermediate size
|
| 18 |
+
- 128 max sequence length
|
| 19 |
+
- **Vocabulary**: GPT-2 tokenizer (50,257 tokens)
|
| 20 |
+
- **Training**: Fine-tuned on TinyStories dataset (1,000 examples)
|
| 21 |
+
- **Quantization**: 8-bit dynamic quantization available for further size reduction
|
| 22 |
+
|
| 23 |
+
## Usage
|
| 24 |
+
|
| 25 |
+
```python
|
| 26 |
+
from transformers import AutoTokenizer
|
| 27 |
+
from model.transformer import TransformerLM
|
| 28 |
+
|
| 29 |
+
# Load model
|
| 30 |
+
model = TransformerLM.from_pretrained("vaidhyamegha/shoonya-v0.1")
|
| 31 |
+
tokenizer = AutoTokenizer.from_pretrained("gpt2")
|
| 32 |
+
|
| 33 |
+
# Generate text
|
| 34 |
+
prompt = "Once upon a time"
|
| 35 |
+
generated = model.generate(prompt, max_length=50)
|
| 36 |
+
print(generated)
|
| 37 |
+
```
|
| 38 |
+
|
| 39 |
+
## Performance Characteristics
|
| 40 |
+
- **Memory Usage**: <2GB RAM during inference
|
| 41 |
+
- **Model Size**:
|
| 42 |
+
- Full model: ~15MB
|
| 43 |
+
- Quantized version: ~4MB
|
| 44 |
+
- **Speed**: ~100ms per inference on standard CPU
|
| 45 |
+
|
| 46 |
+
## Limitations
|
| 47 |
+
- Limited context window (128 tokens)
|
| 48 |
+
- Trained on a small subset of data
|
| 49 |
+
- Best suited for short-form creative writing
|
| 50 |
+
- May produce repetitive text on longer generations
|
| 51 |
+
|
| 52 |
+
## Training
|
| 53 |
+
Trained on a curated subset of the TinyStories dataset, focusing on short, coherent narratives. The model uses a custom implementation of the transformer architecture with specific optimizations for CPU inference.
|
| 54 |
+
|
| 55 |
+
## License
|
| 56 |
+
[Add your chosen license]
|
| 57 |
+
|
| 58 |
+
## Citation
|
| 59 |
+
```bibtex
|
| 60 |
+
@misc{shoonya2025,
|
| 61 |
+
author = {VaidhyaMegha},
|
| 62 |
+
title = {Shoonya: A Lightweight CPU-Friendly Language Model},
|
| 63 |
+
year = {2025},
|
| 64 |
+
publisher = {Hugging Face},
|
| 65 |
+
journal = {Hugging Face Model Hub},
|
| 66 |
+
}
|
| 67 |
+
```
|
| 68 |
+
|
| 69 |
+
## Intended Use
|
| 70 |
+
This model is designed for:
|
| 71 |
+
- Prototyping and experimentation
|
| 72 |
+
- Educational purposes
|
| 73 |
+
- CPU-only environments
|
| 74 |
+
- Resource-constrained settings
|
| 75 |
+
- Short-form text generation
|
| 76 |
+
|
| 77 |
+
## Quantization
|
| 78 |
+
The model comes in two variants:
|
| 79 |
+
1. Full precision (shoonya_model_v0_1.pt)
|
| 80 |
+
2. 8-bit quantized (shoonya_model_v0_1_quantized.pt)
|
| 81 |
+
|
| 82 |
+
The quantized version offers significant size reduction while maintaining reasonable quality.
|