star-ga commited on
Commit
27e6629
Β·
verified Β·
1 Parent(s): 47fa73e

docs: align model card with v0.3.0b9 (hook, acquire, native encoder, pure-MIND migration)

Browse files
Files changed (1) hide show
  1. README.md +67 -16
README.md CHANGED
@@ -7,6 +7,8 @@ tags:
7
  - retrieval
8
  - routing
9
  - agent-runtime
 
 
10
  - mind-nerve
11
  language:
12
  - en
@@ -15,13 +17,45 @@ pipeline_tag: sentence-similarity
15
  library_name: sentence-transformers
16
  ---
17
 
18
- # mind-nerve β€” Phase 1 (v1.1-oss)
19
-
20
- **Intent-classification preselector for agent runtimes.**
21
-
22
- A small, fast classifier that sits between a user request and the host runtime. It reads the request, decides which subset of available tools/skills/agents is relevant, and hands the host a short list β€” so the downstream LLM never sees the full library in its system prompt.
23
-
24
- Result: library size decouples from token cost. Hosting 4,400 skills costs the same prompt budget as hosting 44, because only the top-K are ever loaded per turn.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
25
 
26
  ## Usage
27
 
@@ -40,6 +74,20 @@ The first call auto-downloads this checkpoint into
40
  `~/.local/share/mind-nerve/runtime/`. To pre-seed or use a custom location,
41
  set `MIND_NERVE_RUNTIME_DIR=/path/to/your/runtime/`.
42
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
43
  ## Model
44
 
45
  - **Base model**: `BAAI/bge-small-en-v1.5` (fine-tuned)
@@ -71,20 +119,23 @@ set `MIND_NERVE_RUNTIME_DIR=/path/to/your/runtime/`.
71
  - `route_table.npy` β€” precomputed catalog embeddings (11,922 Γ— 384, float32)
72
  - `route_table.jsonl` β€” catalog metadata (one JSON object per row of `route_table.npy`)
73
 
74
- ## Status
75
-
76
- **Phase 1, public alpha.** Inference runs on PyTorch via the fine-tuned BGE encoder. Phase 2 (target Q3 2027) replaces the PyTorch path with a native MIND Q16.16 inference loop and adds:
77
-
78
- - Cross-architecture bit-identity gate (x86 CPU vs CUDA)
79
- - p95 ≀ 30 ms latency budget on 4-core CPU
80
 
81
- Phase 2 is gated on `mindc` 0.2.6 (`pub fn` β†’ C symbol export) and 0.3.0 (cdylib emit).
 
 
 
 
 
 
 
 
82
 
83
  ## License
84
 
85
  This model card and the weights it points at are released under **Apache-2.0**.
86
 
87
- The PyPI wheel `mind-nerve` bundles a FORTRESS-protected `libmindnerve.so` whose source remains private (STARGA Commercial). The wheel is Apache-2.0; the bundled binary is the protected runtime layer that activates in Phase 2. The Phase 1 inference path published here does not depend on the protected binary.
88
 
89
  For commercial deployments needing per-customer FORTRESS-locked builds of the runtime layer, contact `license@star.ga`.
90
 
@@ -96,6 +147,6 @@ For commercial deployments needing per-customer FORTRESS-locked builds of the ru
96
  title = {mind-nerve: Intent-classification preselector for agent runtimes},
97
  year = {2026},
98
  url = {https://github.com/star-ga/mind-nerve},
99
- version = {0.1.0-alpha.3},
100
  }
101
  ```
 
7
  - retrieval
8
  - routing
9
  - agent-runtime
10
+ - mcp
11
+ - skills
12
  - mind-nerve
13
  language:
14
  - en
 
17
  library_name: sentence-transformers
18
  ---
19
 
20
+ # mind-nerve β€” Intent-classification preselector for agent runtimes
21
+
22
+ **Open the library, hide the cost.** A small, fast classifier sits between a
23
+ user request and the host runtime (Claude Code, codex, grok, kimi, gemini,
24
+ MCP hosts β€” 17 CLI runtimes supported by the installer). It reads the
25
+ request, decides which subset of available skills/tools/agents/MCPs is
26
+ relevant, and hands the host a short list β€” so the downstream LLM never sees
27
+ the full library in its system prompt.
28
+
29
+ Result: library size decouples from token cost. A 1,300+ skill hub is
30
+ reachable for ~2k tokens of announce instead of a ~95k-token bulk listing β€”
31
+ and only the top-K bodies are ever loaded per turn.
32
+
33
+ **Current release: v0.3.0b8+ (public beta).** PyPI:
34
+ [`mind-nerve`](https://pypi.org/project/mind-nerve/) Β· Code:
35
+ [github.com/star-ga/mind-nerve](https://github.com/star-ga/mind-nerve).
36
+
37
+ ## What's new in the beta line
38
+
39
+ - **Per-prompt routing hook** β€” a `UserPromptSubmit` hook queries the routing
40
+ daemon per prompt, projects the relevant skills into the CLI's skills dir
41
+ (atomic symlink flip), and injects a ranked route table with absolute
42
+ `SKILL.md` paths. This is what makes a large hub *reachable* without being
43
+ *announced*.
44
+ - **`mind-nerve acquire`** β€” vetted external acquisition: search curated
45
+ sources (Anthropic's skills repo, the official MCP servers repo, the MCP
46
+ registry API, GitHub search), fetch into a capped quarantine, run a
47
+ deterministic fail-closed static security scan (shell-pipe installers,
48
+ reverse shells, exfiltration collectors, prompt injection incl. MCP tool
49
+ schemas, archive escapes, credential access, persistence hooks), and
50
+ install the clean packages into the hub with per-file SHA-256 manifests
51
+ and a live daemon reindex. Threat model: `docs/acquisition.md` in the repo.
52
+ - **Native Q16.16 encoder bundled** β€” the wheel ships
53
+ `libmind_nerve_encoder.so` with a real `encoder_weights.q16.bin` blob;
54
+ `MIND_NERVE_BACKEND=native` is the default routing path with a PyTorch
55
+ fallback.
56
+ - **Cross-CLI audited** β€” the change set was independently audited by two
57
+ external CLI agents; all critical/high findings fixed with regression
58
+ tests.
59
 
60
  ## Usage
61
 
 
74
  `~/.local/share/mind-nerve/runtime/`. To pre-seed or use a custom location,
75
  set `MIND_NERVE_RUNTIME_DIR=/path/to/your/runtime/`.
76
 
77
+ Wire the per-prompt hook into your CLIs (claude-code, codex, grok, kimi,
78
+ gemini, +12 more):
79
+
80
+ ```bash
81
+ mind-nerve-install install --cli all
82
+ ```
83
+
84
+ Acquire a vetted external skill:
85
+
86
+ ```bash
87
+ mind-nerve acquire search "pdf"
88
+ mind-nerve acquire install <url>
89
+ ```
90
+
91
  ## Model
92
 
93
  - **Base model**: `BAAI/bge-small-en-v1.5` (fine-tuned)
 
119
  - `route_table.npy` β€” precomputed catalog embeddings (11,922 Γ— 384, float32)
120
  - `route_table.jsonl` β€” catalog metadata (one JSON object per row of `route_table.npy`)
121
 
122
+ ## Status & roadmap
 
 
 
 
 
123
 
124
+ **Public beta (v0.3.0b8+).** The PyTorch reference path above drives the
125
+ catalog; the bundled native Q16.16 encoder is the default routing path.
126
+ The active workstream is the **pure-MIND migration**: the repo's end state
127
+ is MIND-only (router core, CLI, daemon, MCP server, hook, installer as a
128
+ compiled native binary), tracked in
129
+ [ROADMAP.md](https://github.com/star-ga/mind-nerve/blob/main/ROADMAP.md).
130
+ mindc is at 0.10.2; the kernel tree compiles under a fail-closed CI gate.
131
+ Cross-arch bit-identity for CUDA (task #57) remains open β€” the emit path,
132
+ not the hardware, is the blocker.
133
 
134
  ## License
135
 
136
  This model card and the weights it points at are released under **Apache-2.0**.
137
 
138
+ The PyPI wheel `mind-nerve` bundles a FORTRESS-protected `libmindnerve.so` whose source remains private (STARGA Commercial). The wheel is Apache-2.0; the bundled binary is the protected runtime layer. The Phase 1 inference path published here does not depend on the protected binary.
139
 
140
  For commercial deployments needing per-customer FORTRESS-locked builds of the runtime layer, contact `license@star.ga`.
141
 
 
147
  title = {mind-nerve: Intent-classification preselector for agent runtimes},
148
  year = {2026},
149
  url = {https://github.com/star-ga/mind-nerve},
150
+ version = {0.3.0b9},
151
  }
152
  ```