Skip to content

Commit 6729140

Browse files
committed
docs: substantive CRG C annotation (EXPLAINME.adoc)
1 parent 6659e0c commit 6729140

1 file changed

Lines changed: 221 additions & 6 deletions

File tree

EXPLAINME.adoc

Lines changed: 221 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,239 @@
11
// SPDX-License-Identifier: PMPL-1.0-or-later
2+
// Copyright (c) 2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
23
= Neural Foundations — Show Me The Receipts
34
:toc:
5+
:toclevels: 3
46
:icons: font
7+
:author: Jonathan D.A. Jewell
58

6-
The README makes claims. This file backs them up.
9+
The README makes claims. This file backs them up with structural detail,
10+
code paths, and honest caveats sufficient for an external reviewer to know
11+
where each satellite lives, what it implements, and how the boundaries are
12+
drawn between this repo and the application-level repos that consume it.
13+
14+
NOTE: License note — this repo declares `MPL-2.0-or-later` for
15+
platform/tooling compatibility (some satellite dependencies require an
16+
OSI-approved licence). The PMPL text is provided in `license/PMPL-1.0.txt`;
17+
PMPL is the preferred licence where technically possible.
18+
19+
== Claim 1: "Core technologies, not applications — LLM infrastructure, agentic systems, neurosymbolic computing"
20+
21+
[quote, README]
22+
____
23+
Neural Foundations is the primary repository for AI and neural computing core
24+
technologies — the fundamental building blocks, not their applications.
25+
____
26+
27+
=== How it works
28+
29+
The repo is a hub-and-satellite structure. The hub (this repo) contains the
30+
topology map, governance, and the shared git-submodule wiring. The satellites
31+
are independent repos cloned into `satellites/`:
32+
33+
[source]
34+
----
35+
satellites/
36+
├── foundation-models/ # LLM infrastructure
37+
│ ├── llm-antidote/ # Semantic reset artifacts
38+
│ ├── llm-unify/ # Unified LLM conversation interface
39+
│ ├── llm-unify-core/ # Core types for multi-provider management
40+
│ └── patallm-gallery/ # LLM pattern library
41+
├── agentic/ # Multi-agent orchestration
42+
│ ├── agentic-scm/ # Machine-readable agent behaviour patterns
43+
│ ├── conative-gating/ # AI-controlling-AI with adversarial incentives
44+
│ └── elegant-state/ # Local-first multi-agent state graph
45+
└── neurosymbolic/ # Hybrid neural-symbolic systems
46+
├── neurosym-scm/ # Core neurosymbolic pattern definitions
47+
├── echidna/ # Multi-prover theorem proving platform
48+
├── neurophone/ # Android spiking-NN + LLM app
49+
├── esn/ # Echo State Networks (Rust)
50+
├── lsm/ # Liquid State Machines (Rust)
51+
├── disinfo-nesy-detector/ # Disinformation detection
52+
└── zotero-nesy/ # Knowledge extraction for academic research
53+
----
54+
55+
The division between "here" and "elsewhere" is explicit in the README. If a
56+
project uses LLM protocols (MCP, tool calling), it belongs in `poly-mcps`.
57+
If it is an AI-powered git tool, it belongs in `oikos`. Neural foundations
58+
only houses the underlying mechanisms — the conversation interface types, the
59+
reservoir computing implementations, the theorem-proving platform.
60+
61+
=== Code path: conative-gating
62+
63+
`conative-gating` (in `satellites/agentic/`) implements AI controlling AI
64+
with adversarial incentives: a second model trained with inverted reward
65+
signals — rewarded for blocking, suspicious by default — acts as a gate on
66+
the primary model's proposals. This is the "conative" (will/volition) layer
67+
above the "cognitive" (reasoning) layer. The gate is not a filter applied
68+
after decisions; it is a co-equal agent in the deliberation.
69+
70+
=== Code path: ESN and LSM
71+
72+
`satellites/neurosymbolic/esn/` is a Rust implementation of Echo State
73+
Networks — fixed random reservoirs where only the readout layer is trained.
74+
`satellites/neurosymbolic/lsm/` is a Rust implementation of Liquid State
75+
Machines (spiking neuron reservoirs). Both are zero-unsafe, benchmarked,
76+
and designed as drop-in components for any Rust codebase needing temporal
77+
pattern recognition without a full deep learning stack.
78+
79+
=== Honest caveat
80+
81+
"Neural foundations" is an aspirational scope statement as much as a
82+
description of current state. Several satellites are early-stage research
83+
sketches rather than production libraries. The `TOPOLOGY.md` document
84+
distinguishes complete satellites from work-in-progress by tier. An
85+
external reviewer should consult `TOPOLOGY.md` before assuming any given
86+
satellite is deployable.
87+
88+
== Claim 2: "Echidna: multi-prover neurosymbolic theorem proving platform"
789

890
[quote, README]
991
____
10-
This project must declare **MPL-2.0-or-later** for platform/tooling compatibility.
92+
ECHIDNA — Extensible Cognitive Hybrid Intelligence for Deductive Neural
93+
Assistance. A neurosymbolic theorem proving platform that transforms Quill
94+
(Agda-only neural solver) into a universal multi-prover system.
1195
____
1296

97+
=== How it works
98+
99+
`satellites/neurosymbolic/echidna/` is a Rust project (Cargo workspace) with:
100+
101+
* An `echidna` prover orchestration library
102+
* Language adapters for Coq, Lean 4, Agda, and Isabelle
103+
* Aspect tagging — annotating theorems with semantic categories
104+
* OpenCyc integration for common-sense ontology context
105+
* DeepProbLog probabilistic logic support
106+
107+
`echidna` is also the backend for `gitbot-fleet/bots/echidnabot/` — the CI
108+
integration layer that verifies proofs on every push. The arXiv paper source
109+
is in `satellites/neurosymbolic/echidna/arcvix-neurosymbolic-theorem-proving.tex`.
110+
111+
The API surface is in `satellites/neurosymbolic/echidna/api/`, which exposes
112+
a JSON HTTP interface that `echidnabot` calls for CI verification.
113+
114+
=== Honest caveat
115+
116+
Echidna is the most mature satellite. The multi-prover support is real.
117+
However, the OpenCyc integration and DeepProbLog support are partially
118+
implemented — the architecture is wired, the full ontology depth is not.
119+
The CHANGELOG and ROADMAP in the echidna directory document what is
120+
functional versus what is planned.
121+
122+
== Dogfooded Across The Account
123+
124+
[cols="1,2,2"]
125+
|===
126+
| Technology | Role in Neural Foundations | Also Used In
127+
128+
| *Rust*
129+
| ESN, LSM, and echidna core implementations. Zero unsafe, benchmarked.
130+
| ephapax, verisimdb, gitbot-fleet, protocol-squisher
131+
132+
| *ReScript*
133+
| Web visualisations and UIs for satellite tools
134+
| idaptik, panll, gossamer-powered SPAs, developer-ecosystem
135+
136+
| *Deno*
137+
| Orchestration and API servers for foundation-model satellites
138+
| Universal across the account; llm-unify uses Deno for its API server
139+
140+
| *Echidna* (this repo)
141+
| The theorem proving platform is developed here
142+
| gitbot-fleet/echidnabot (CI consumer), maa-framework/absolute-zero (proof
143+
verification), ephapax (Coq proofs verified by echidna)
144+
145+
| *Hypatia*
146+
| Security and quality scanning of satellites
147+
| Every RSR repo in the account
148+
149+
| *Stapeln containers*
150+
| `stapeln.toml` for satellite deployment
151+
| All containerised services in the account
152+
153+
| *Contractile.just*
154+
| `contractile.just` — shared build recipes across satellites
155+
| Universal across hyperpolymath repos
156+
|===
157+
13158
== File Map
14159

15-
[cols="1,2"]
160+
[cols="1,3"]
16161
|===
17-
| Path | What's There
162+
| Path | What It Proves
163+
164+
| `satellites/foundation-models/llm-unify/`
165+
| Unified LLM conversation interface. Abstracts provider differences
166+
(OpenAI, Anthropic, Google) into a consistent API. The primary integration
167+
point for any repo that needs multi-provider LLM access.
168+
169+
| `satellites/foundation-models/llm-unify-core/`
170+
| Shared type definitions used by llm-unify and any other consumer.
171+
`core` suffix means: types only, no side effects, no I/O.
172+
173+
| `satellites/foundation-models/llm-antidote/`
174+
| Semantic reset artefacts — techniques for clearing, resetting, or
175+
redirecting LLM context. Useful when persistent context accumulates
176+
undesirable priors.
177+
178+
| `satellites/foundation-models/patallm-gallery/`
179+
| Reference architectures and proven patterns for LLM integration. The
180+
pattern library for this ecosystem.
181+
182+
| `satellites/agentic/conative-gating/`
183+
| Adversarial gating: a second AI model rewarded for blocking the first.
184+
The critical path for AI safety work in this account.
185+
186+
| `satellites/agentic/elegant-state/`
187+
| Local-first state graph for multi-agent coordination. Agents share state
188+
without a central server.
189+
190+
| `satellites/agentic/agentic-scm/`
191+
| Machine-readable agent behaviour and interaction patterns (A2ML format).
192+
193+
| `satellites/neurosymbolic/echidna/`
194+
| Multi-prover theorem proving platform. `src/` is the Rust core. `api/`
195+
is the HTTP interface consumed by echidnabot. `arcvix-*.tex` is the paper
196+
source. Most mature satellite in the neurosymbolic cluster.
197+
198+
| `satellites/neurosymbolic/esn/`
199+
| Echo State Networks in Rust. Fixed random reservoir, trained readout only.
200+
`benches/` covers time-series prediction throughput.
201+
202+
| `satellites/neurosymbolic/lsm/`
203+
| Liquid State Machines (spiking neuron reservoirs) in Rust.
204+
205+
| `satellites/neurosymbolic/neurophone/`
206+
| Android application: spiking NN + LLM on mobile. Combines ESN/LSM
207+
components with an on-device LLM for edge inference.
208+
209+
| `satellites/neurosymbolic/disinfo-nesy-detector/`
210+
| Disinformation and AI-generated content detection using neurosymbolic
211+
techniques. Combines statistical and symbolic evidence.
212+
213+
| `satellites/neurosymbolic/zotero-nesy/`
214+
| Knowledge extraction from Zotero academic libraries for neurosymbolic
215+
reasoning. Wittgenstein quote in the README is the design philosophy:
216+
only say what can be said clearly.
217+
218+
| `satellites/neurosymbolic/neurosym-scm/`
219+
| Core neurosymbolic pattern definitions in A2ML format. Shared ontology
220+
for the neurosymbolic cluster.
221+
222+
| `tests/`
223+
| Cross-satellite integration tests.
224+
225+
| `.machine_readable/`
226+
| A2ML checkpoint files (STATE, META, ECOSYSTEM, AGENTIC, NEUROSYM, PLAYBOOK).
227+
Canonical AI session state.
18228

19-
| `test(s)/` | Test suite
229+
| `TOPOLOGY.md`
230+
| Visual map of satellites, their relationships, and completion status.
231+
The honest "what exists now" document.
20232
|===
21233

22234
== Questions?
23235

24-
Open an issue or reach out directly — happy to explain anything in more detail.
236+
Start with `TOPOLOGY.md` for the current state of each satellite. For the
237+
proving platform, start with `satellites/neurosymbolic/echidna/README.adoc`.
238+
For foundation model access, start with
239+
`satellites/foundation-models/llm-unify/`.

0 commit comments

Comments
 (0)