snapkitty
machine-learning
python
SNAPKITTYWEST commited on
Commit
5cf587e
Β·
verified Β·
1 Parent(s): 1817730

Sync with GitHub, license metadata from LICENSE files, commercial license notice

Browse files

metadata license: None -> other (snapkitty-tri-license)
README: License section appended
README: GitHub source link added

Files changed (1) hide show
  1. README.md +104 -82
README.md CHANGED
@@ -1,82 +1,104 @@
1
- # sovlm
2
-
3
- ![Python](https://img.shields.io/badge/python-3.11+-blue?style=flat-square)
4
- ![Zero GPU](https://img.shields.io/badge/GPU-zero-black?style=flat-square)
5
- ![Zero Training](https://img.shields.io/badge/training-zero-black?style=flat-square)
6
- ![License](https://img.shields.io/badge/license-SOVEREIGN-gold?style=flat-square)
7
- ![Author](https://img.shields.io/badge/author-Ahmad_Ali_Parr-red?style=flat-square)
8
-
9
- **Sovereign Statistical Language Model.**
10
- N-grams + Kneser-Ney + BM25 Retrieval + QRNG sampling.
11
- No training. No backprop. No GPU. Pure governance.
12
-
13
- Part of the SnapKitty Collective sovereign AI stack.
14
-
15
- ---
16
-
17
- ## Install
18
-
19
- ```bash
20
- pip install -e ".[dev]"
21
- # or
22
- uv pip install -e ".[dev]"
23
- ```
24
-
25
- ## Usage
26
-
27
- ```bash
28
- # Build from your corpus (Lean proofs, Prolog, docs, anything)
29
- sovlm build data/*.lean data/*.pl data/*.md --order 4
30
-
31
- # Generate
32
- sovlm generate -p "theorem main : " -m 200
33
-
34
- # Stream
35
- sovlm generate -p "The 49th Call is" --stream
36
-
37
- # Quantum RNG sampling
38
- sovlm generate -p "lemma " --qrng
39
-
40
- # Serve HTTP API
41
- sovlm serve --port 8080
42
- ```
43
-
44
- ## Python API
45
-
46
- ```python
47
- from sovlm import Generator, build_from_paths
48
- from pathlib import Path
49
-
50
- # Build
51
- d, ng, sg, inv, fz = build_from_paths([Path("corpus.md")], ...)
52
-
53
- # Generate
54
- gen = Generator(d, kn, sg, fz, inv, blender, sampler)
55
- result = gen.generate("theorem xor_assoc : ", max_tokens=100)
56
- ```
57
-
58
- ## Architecture
59
-
60
- | Component | Role |
61
- |---|---|
62
- | `Dictionary` | Vocabulary sovereignty β€” you own the tokens |
63
- | `NGramIndex` | Local coherence β€” what follows what |
64
- | `KneserNey` | Smoothing β€” handle unseen contexts |
65
- | `SkipGramIndex` | Structural patterns at distance |
66
- | `FuzzyPrefixIndex` | LSH near-miss β€” graceful degradation |
67
- | `InvertedIndex + BM25` | Retrieval β€” what's relevant in corpus |
68
- | `Blender` | Arbitration β€” Markov vs retrieval |
69
- | `Sampler + QRNG` | Entropy β€” unbiased, quantum-seeded choice |
70
-
71
- ## SnapKitty Stack Integration
72
-
73
- ```
74
- sovlm ──► abjad-machine (SUBLEQ address space)
75
- ──► sovereign-transformer (plasma gate)
76
- ──► the-49th-call (Lean 4 verified)
77
- ──► bob-orchestrator (Byzantine council)
78
- ```
79
-
80
- ---
81
-
82
- *Ahmad Ali Parr Β· SnapKitty Collective Β· 2026*
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: other
3
+ license_name: snapkitty-tri-license
4
+ license_link: https://huggingface.co/Snapkitty/sovlm/blob/main/LICENSE.tri
5
+ tags:
6
+ - snapkitty
7
+ ---
8
+
9
+ > Source: [github.com/SNAPKITTYWEST/sovlm](https://github.com/SNAPKITTYWEST/sovlm)
10
+
11
+ # sovlm
12
+
13
+ ![Python](https://img.shields.io/badge/python-3.11+-blue?style=flat-square)
14
+ ![Zero GPU](https://img.shields.io/badge/GPU-zero-black?style=flat-square)
15
+ ![Zero Training](https://img.shields.io/badge/training-zero-black?style=flat-square)
16
+ ![License](https://img.shields.io/badge/license-SOVEREIGN-gold?style=flat-square)
17
+ ![Author](https://img.shields.io/badge/author-Ahmad_Ali_Parr-red?style=flat-square)
18
+
19
+ **Sovereign Statistical Language Model.**
20
+ N-grams + Kneser-Ney + BM25 Retrieval + QRNG sampling.
21
+ No training. No backprop. No GPU. Pure governance.
22
+
23
+ Part of the SnapKitty Collective sovereign AI stack.
24
+
25
+ ---
26
+
27
+ ## Install
28
+
29
+ ```bash
30
+ pip install -e ".[dev]"
31
+ # or
32
+ uv pip install -e ".[dev]"
33
+ ```
34
+
35
+ ## Usage
36
+
37
+ ```bash
38
+ # Build from your corpus (Lean proofs, Prolog, docs, anything)
39
+ sovlm build data/*.lean data/*.pl data/*.md --order 4
40
+
41
+ # Generate
42
+ sovlm generate -p "theorem main : " -m 200
43
+
44
+ # Stream
45
+ sovlm generate -p "The 49th Call is" --stream
46
+
47
+ # Quantum RNG sampling
48
+ sovlm generate -p "lemma " --qrng
49
+
50
+ # Serve HTTP API
51
+ sovlm serve --port 8080
52
+ ```
53
+
54
+ ## Python API
55
+
56
+ ```python
57
+ from sovlm import Generator, build_from_paths
58
+ from pathlib import Path
59
+
60
+ # Build
61
+ d, ng, sg, inv, fz = build_from_paths([Path("corpus.md")], ...)
62
+
63
+ # Generate
64
+ gen = Generator(d, kn, sg, fz, inv, blender, sampler)
65
+ result = gen.generate("theorem xor_assoc : ", max_tokens=100)
66
+ ```
67
+
68
+ ## Architecture
69
+
70
+ | Component | Role |
71
+ |---|---|
72
+ | `Dictionary` | Vocabulary sovereignty β€” you own the tokens |
73
+ | `NGramIndex` | Local coherence β€” what follows what |
74
+ | `KneserNey` | Smoothing β€” handle unseen contexts |
75
+ | `SkipGramIndex` | Structural patterns at distance |
76
+ | `FuzzyPrefixIndex` | LSH near-miss β€” graceful degradation |
77
+ | `InvertedIndex + BM25` | Retrieval β€” what's relevant in corpus |
78
+ | `Blender` | Arbitration β€” Markov vs retrieval |
79
+ | `Sampler + QRNG` | Entropy β€” unbiased, quantum-seeded choice |
80
+
81
+ ## SnapKitty Stack Integration
82
+
83
+ ```
84
+ sovlm ──► abjad-machine (SUBLEQ address space)
85
+ ──► sovereign-transformer (plasma gate)
86
+ ──► the-49th-call (Lean 4 verified)
87
+ ──► bob-orchestrator (Byzantine council)
88
+ ```
89
+
90
+ ---
91
+
92
+ *Ahmad Ali Parr Β· SnapKitty Collective Β· 2026*
93
+
94
+ ---
95
+
96
+ ## License
97
+
98
+ Licensed under **SnapKitty Tri-License**. Full text: [LICENSE.tri](LICENSE.tri).
99
+
100
+ ### πŸ’Ό Commercial License
101
+
102
+ Snapkitty code is free and open under **AGPL-3.0** for open-source use. Building a commercial product or service? A **proprietary commercial license** from Snapkitty Collective LLC lets you ship this code without the AGPL's source-sharing and network-use obligations.
103
+
104
+ **[β†’ Get a commercial license](mailto:A.parr@belespritdaccord.uk?subject=Commercial%20license:%20sovlm)** Β· A.parr@belespritdaccord.uk