Skip to content

Commit 8bdfc59

Browse files
committed
Refresh Converge README and docs
1 parent bf74a24 commit 8bdfc59

19 files changed

Lines changed: 310 additions & 121 deletions

.github/dependabot.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "cargo"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
open-pull-requests-limit: 5

.github/workflows/ci.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
15+
- name: Install Rust
16+
uses: dtolnay/rust-toolchain@stable
17+
with:
18+
toolchain: 1.92.0
19+
components: rustfmt, clippy
20+
21+
- name: Cache cargo
22+
uses: Swatinem/rust-cache@v2
23+
24+
- name: Format
25+
run: cargo fmt --all -- --check
26+
27+
- name: Clippy
28+
run: cargo clippy --workspace --all-targets -- -D warnings
29+
30+
- name: Test
31+
run: cargo test --workspace

CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
6+
7+
## Unreleased
8+
9+
## 0.1.0
10+
11+
### Added
12+
13+
- Converge Rust workspace with `converge-lang` and `converge-cli`
14+
- Lexer and parser for a small Converge subset
15+
- Basic semantic validation for neurons layers and connections
16+
- `converge check` and `converge ast` developer commands
17+
- `converge cvir` canonical JSON IR emitter
18+
- Example programs in `examples/`
19+

CODE_OF_CONDUCT.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
- Trolling, insulting or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at eros@blackdream.ai. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
74+
75+
Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
76+
77+
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
78+

CONTRIBUTING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributing to Converge
2+
3+
Thanks for helping. Converge is pre alpha, so small sharp changes win.
4+
5+
## Prerequisites
6+
7+
1. Rust stable installed
8+
2. Minimum supported Rust is 1.92
9+
10+
## Build and test
11+
12+
```bash
13+
cargo test
14+
cargo run -p converge-cli -- check examples/hello.cv
15+
```
16+
17+
## Formatting and linting
18+
19+
```bash
20+
cargo fmt --all
21+
cargo clippy --workspace --all-targets
22+
```
23+
24+
CI enforces `cargo fmt --check` and `cargo clippy -D warnings` so keep it clean.
25+
26+
## How to add a syntax feature
27+
28+
Touchpoints are intentionally simple.
29+
30+
1. Add tokens if needed in `crates/converge-lang/src/lexer.rs`
31+
2. Extend AST in `crates/converge-lang/src/ast.rs`
32+
3. Parse it in `crates/converge-lang/src/parser.rs`
33+
4. Validate semantics in `crates/converge-lang/src/validate.rs`
34+
5. Emit stable IR in `crates/converge-lang/src/emit.rs`
35+
6. Add an example in `examples/` and add or extend tests in `crates/converge-lang/src/parser.rs`
36+
37+
## What we care about
38+
39+
1. Deterministic behavior
40+
2. Clear diagnostics
41+
3. Stable IR output
42+
4. Honest docs
43+

README.md

Lines changed: 39 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,35 @@
1-
# Converge
1+
<p align="center">
2+
<img src="assets/converge-logo-256.jpg" width="256" height="256" alt="Converge logo">
3+
</p>
4+
<h1 align="center">Converge</h1>
5+
<p align="center"><strong>A time first language and toolchain for hybrid neuromorphic classical systems.</strong></p>
26

3-
Converge is a **time‑first programming language + toolchain** for building **hybrid neuromorphic–classical systems**: spiking networks, event streams, synaptic plasticity, and the host code that orchestrates them.
7+
## What Converge is
48

5-
It’s inspired by the *whole‑stack audacity* of projects like TempleOS/HolyC — not in aesthetics, but in ethos:
9+
Converge is a time first programming language and compiler toolchain for hybrid neuromorphic classical systems. It targets spiking networks event streams synaptic plasticity and the host code that orchestrates them.
610

7-
- **One coherent stack** you can hold in your head: language → compiler → IR → simulator → hardware backends.
8-
- **Explicitness over magic**: time, units, delays, learning rules, and IO are first‑class.
9-
- **Inspectable artifacts**: compilation emits human‑readable IR and deterministic reports.
11+
It’s built around a simple insistence. Time isn’t metadata, it’s the program. Converge treats events delays and units as first class so you can compile the same intent into simulation interchange and hardware backends without rewriting the meaning.
1012

11-
Status: **pre‑α** (this repo is the start of the compiler/runtime).
13+
Converge emits a canonical intermediate form called CVIR and it’s being shaped to align with NIR for ecosystem interchange. It’s early. The direction is not.
1214

13-
---
15+
Status: pre alpha.
1416

15-
## Why this exists
17+
## Thesis
1618

17-
Neuromorphic systems are arriving as **heterogeneous fabrics** (digital SNN chips, mixed‑signal accelerated-time systems, event-based sensors, and hybrid cloud access), and they increasingly live inside **classical control loops**. The painful part is not “writing a network” — it’s:
19+
Neuromorphic systems don’t arrive as a single chip and a single SDK. They arrive as fabrics. You’ve got event based sensors, host control loops, routing constraints, quantization rules and timing jitter. If your program can’t name time precisely, you’ll be debugging folklore.
1820

19-
- **Time semantics** (discrete vs event-driven; delays; scheduling).
20-
- **Hardware partitioning** (what runs on the host vs the neuromorphic fabric).
21-
- **Interchange** between ecosystems (simulation, training, deployment).
22-
- **Reproducibility** (randomness, quantization, routing constraints, and timing).
21+
Converge is not a Python SNN library replacement. It’s a compiler toolchain that makes time explicit, makes artifacts inspectable and keeps execution deterministic enough to ship.
2322

24-
Converge’s bet: treat *time and events as the IR*, then compile down into whatever “fabric” you have.
23+
## Design principles
2524

26-
---
25+
1. Time is explicit in source and in IR.
26+
2. Units are part of meaning and they can’t be shrugged off.
27+
3. Determinism is a feature, not a nice to have.
28+
4. If you can’t inspect it, you can’t deploy it.
29+
5. Hardware comes later, semantics come first.
30+
6. Interop is mandatory, not aspirational.
2731

28-
## The Converge stack (current direction)
32+
## Architecture
2933

3034
```mermaid
3135
flowchart LR
@@ -39,102 +43,38 @@ flowchart LR
3943
E --> E4["hw targets (THOR / SpiNNaker2 / BrainScaleS-2)"]
4044
```
4145

42-
**CVIR** is intentionally shaped to align with **NIR (Neuromorphic Intermediate Representation)** for ecosystem interchange.
46+
Today you’ve got the front end plus a validator and a CVIR JSON emitter. Next you’ll get a deterministic simulator core then an interchange pipeline and finally hardware codegen.
4347

44-
---
48+
## Quick start
4549

46-
## Language at a glance (fabric DSL)
47-
48-
Converge’s “fabric” layer is declarative: you describe neuron models, populations, connectivity, learning rules, and time.
49-
50-
```converge
51-
neuron LIF {
52-
tau_m = 20 ms
53-
v_th = 1.0 V
54-
}
55-
56-
layer Input[100] : LIF
57-
layer Hidden[300] : LIF
58-
layer Output[10] : LIF
59-
60-
connect Input -> Hidden { w = Uniform(-1.0, 1.0) d = Normal(1 ms, 0.1 ms) }
61-
connect Hidden -> Output { w = Uniform(-1.0, 1.0) d = Normal(1 ms, 0.1 ms) }
62-
63-
run for 1 s
64-
```
65-
66-
**Important:** the compiler/runtime will ultimately support both *event-driven* and *clocked* execution, but the semantics will remain *time-explicit* in source and IR.
67-
68-
---
69-
70-
## Quick start (today)
71-
72-
You need Rust (`rustc`/`cargo`).
50+
You need Rust stable. Minimum supported Rust is 1.92.
7351

7452
```bash
53+
cargo test
7554
cargo run -p converge-cli -- check examples/hello.cv
7655
cargo run -p converge-cli -- ast examples/hello.cv
56+
cargo run -p converge-cli -- cvir examples/hello.cv
7757
```
7858

79-
---
80-
81-
## Scope (what Converge is / isn’t)
82-
83-
Converge is not “yet another Python SNN library”. It’s a **compiler toolchain** meant to:
84-
85-
- Represent neuromorphic programs in a **hardware-agnostic** but *timing-precise* IR.
86-
- **Partition** across a host CPU/GPU and neuromorphic fabric (hybrid arrays).
87-
- Emit **multiple deployment targets** (simulators, interchange formats, vendor SDKs).
88-
89-
Converge does *not* try to replace existing ML ecosystems. Instead it aims to be the missing bridge layer:
90-
source → IR → (NIR/Lava/…).
91-
92-
---
93-
94-
## Ecosystem alignment (bleeding edge references)
95-
96-
Hardware and platforms Converge is designed to target (over time):
97-
98-
- **Intel Loihi 2 / Hala Point** neuromorphic system (Loihi 2–based, large-scale SNN hardware).
99-
- **SpiNNaker2** (many-core, event-driven neuromorphic platform; e.g., SpiNNcloud deployments).
100-
- **BrainScaleS‑2** (mixed-signal neuromorphic with accelerated-time dynamics).
101-
- **Neuromorphic Commons (THOR)**: shared access to neuromorphic systems for researchers.
102-
103-
Software ecosystems Converge will interoperate with rather than replace:
104-
105-
- **Lava** (Intel’s neuromorphic software framework).
106-
- **NIR (Neuromorphic Intermediate Representation)** as the interchange layer between frameworks/hardware.
107-
- **Nengo**, **Brian2**, **Norse**, **snnTorch** (simulation/training ecosystems Converge can exchange with via IR and codegen).
108-
109-
See `docs/references.md` for links and short notes.
110-
See `docs/spec.md` for the current accepted grammar (pre‑α).
111-
112-
---
113-
114-
## Security & robustness (responsible research)
115-
116-
Neuromorphic systems need the equivalent of “fuzzing + fault injection + timing adversaries”.
117-
Converge intends to support **pathology-inspired robustness testing** (e.g., timing jitter, spike corruption, routing congestion, state rollback) as *first-class simulation modes*.
118-
119-
This is for defensive engineering and scientific study. No “malware DSL” lives here.
59+
## Docs
12060

121-
---
61+
1. `docs/spec.md` current accepted grammar and validation rules
62+
2. `docs/references.md` curated anchors for hardware and interchange
63+
3. `docs/voice.md` writing rules for project docs
64+
4. `docs/brand.md` logo and asset guidance
12265

123-
## Roadmap (high-level)
66+
## Origin
12467

125-
- **0.1**: parser + AST + validation + stable diagnostics
126-
- **0.2**: CVIR + deterministic simulation kernel (LIF + basic synapses)
127-
- **0.3**: NIR export/import
128-
- **0.4**: Lava codegen backend (Loihi/Lava workflows)
129-
- **0.5**: partitioning + scheduling cost models (hybrid host/fabric)
68+
Converge is conceived by Eros and it’s being built in open collaboration with AI tooling. You’ll see that stance in the artifacts. The repo is designed to be read, not just executed.
13069

131-
---
70+
## Contributing
13271

133-
## License
72+
Read `CONTRIBUTING.md` then pick something small and make it sharp. If you add syntax you’ll add tests and you’ll keep the IR stable.
13473

135-
MIT. See `LICENSE`.
74+
## Security
13675

137-
## Contact
76+
Read `SECURITY.md` for reporting. Converge will support defensive robustness testing and fault injection. It won’t ship offense code.
13877

139-
Open an issue, or email eros@blackdream.ai.
78+
## License and contact
14079

80+
MIT. See `LICENSE`. Open an issue or email eros@blackdream.ai.

SECURITY.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Security policy
2+
3+
Converge is pre alpha and security support is best effort.
4+
5+
## Reporting a vulnerability
6+
7+
Email eros@blackdream.ai with:
8+
9+
1. A clear description of the issue
10+
2. Steps to reproduce
11+
3. Expected behavior and actual behavior
12+
4. Your environment details, including OS and Rust version
13+
14+
If you can provide a minimal Converge source file that triggers the issue, include it.
15+

assets/converge-logo-256.jpg

33.9 KB
Loading

assets/converge-logo.jpg

433 KB
Loading

assets/converge-logo.webp

341 KB
Loading

0 commit comments

Comments
 (0)