Skip to content

Commit 09e98c2

Browse files
cognectclaude
andcommitted
docs: align README + ai-skills + RELEASING with atomr formatting
* README rewritten to mirror atomr's structure: "Why ... in Rust, now" rationale, "What's in the box" crate table, separate "Quick start (Rust)" and "Quick start (Python)" sections, "Building from source", "Layout" tree, "Learn more" doc index. * All "0.0" / "0.2.x" version references in docs/, ai-skills/, RELEASING.md, README.md updated to "0.1" (matches the v0.1.0 rebrand cut on crates.io / PyPI). * "atomr 0.2 integration / adoption" phrasing trimmed since the pinned-version flavor is no longer meaningful — atomr-accel just tracks atomr now. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent d00e4ce commit 09e98c2

9 files changed

Lines changed: 246 additions & 167 deletions

File tree

README.md

Lines changed: 220 additions & 141 deletions
Large diffs are not rendered by default.

RELEASING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ TestPyPI for wheel uploads.
8888

8989
```bash
9090
# crates.io
91-
cargo yank --vers 0.0.2 atomr-accel
92-
cargo yank --vers 0.0.2 atomr-accel-patterns
91+
cargo yank --vers 0.1.0 atomr-accel
92+
cargo yank --vers 0.1.0 atomr-accel-patterns
9393
# ...etc
9494

9595
# PyPI: open the project page → Manage → Releases → Yank.

ai-skills/skills/atomr-accel-backends/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ exists for code that genuinely benefits from it.
130130

131131
| Backend | Status | Notes |
132132
|---|---|---|
133-
| **CUDA (NVIDIA)** | **Shipping** in `atomr-accel-cuda` | Full F2-F9 + atomr 0.2 integration. |
133+
| **CUDA (NVIDIA)** | **Shipping** in `atomr-accel-cuda` | Full F2-F9 + atomr integration. |
134134
| ROCm (AMD) | Designed for | hipBLAS / hipFFT / rocSPARSE / rocSOLVER map cleanly. RCCL ≈ NCCL. |
135135
| Metal (Apple) | Designed for | MPS + Metal command queues fit `AccelStream` directly. No NVRTC equivalent (use Metal compute shaders compiled at build time). |
136136
| oneAPI (Intel) | Designed for | SYCL + oneMKL libraries. |

ai-skills/skills/atomr-accel-getting-started/SKILL.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ pulls of the other blueprints.
5050

5151
```toml
5252
[dependencies]
53-
atomr-accel-cuda = "0.2"
53+
atomr-accel-cuda = "0.1"
5454
tokio = { version = "1", features = ["rt-multi-thread", "macros"] }
5555
```
5656

@@ -72,7 +72,7 @@ no-op when it's missing.
7272
| TelemetryExtension probes | `atomr-accel-cuda = { features = ["telemetry"] }` |
7373

7474
Aggregates compose: `core-libs``training-libs``full-cuda`.
75-
The four atomr-0.2 integration features (`replay`, `cluster`,
75+
The four atomr integration features (`replay`, `cluster`,
7676
`streams`, `telemetry`) are independent of the library aggregates.
7777

7878
For a goal-by-goal picker with explicit transitive-deps tables, see
@@ -82,8 +82,8 @@ For a goal-by-goal picker with explicit transitive-deps tables, see
8282

8383
```toml
8484
[dependencies]
85-
atomr-accel-cuda = "0.2"
86-
atomr-accel-patterns = "0.2" # adds DynamicBatchingServer, etc.
85+
atomr-accel-cuda = "0.1"
86+
atomr-accel-patterns = "0.1" # adds DynamicBatchingServer, etc.
8787
```
8888

8989
Only adds the patterns crate; `train` / `agents` / `realtime`
@@ -173,7 +173,7 @@ plumbing" checks.
173173
`DeviceActor::pre_start` spawns child actors and uses
174174
`tokio::spawn` internally — the runtime needs a multi-threaded
175175
scheduler.
176-
- **Pinning to `atomr-accel = "0.2"` with no `features = ["cuda"]`.**
176+
- **Pinning to `atomr-accel = "0.1"` with no `features = ["cuda"]`.**
177177
The umbrella crate ships only the trait surface by default; you
178178
also need `cuda` to get the concrete `DeviceActor`. Most projects
179179
should depend on `atomr-accel-cuda` directly instead.

ai-skills/skills/atomr-accel-supervision/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ panic!("ContextPoisoned: cublasCreate returned {status:?}");
7171
The application **never writes its own decider** unless it's
7272
running its own non-CUDA actor next to the device. For
7373
that, [`atomr-accel-cuda::error::DeviceSupervisor`](../../../crates/atomr-accel-cuda/src/error.rs)
74-
implements atomr 0.2's typed `SupervisorOf<ContextActor>` trait
74+
implements atomr's typed `SupervisorOf<ContextActor>` trait
7575
over `GpuError`, so you can pattern-match on the typed enum
7676
directly:
7777

ai-skills/skills/atomr-accel-troubleshooting/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ are gated:
3636
| `observability::install`, `GpuProbes` | `telemetry` |
3737

3838
```toml
39-
atomr-accel-cuda = { version = "0.2", features = ["cudnn", "nvrtc", "replay"] }
39+
atomr-accel-cuda = { version = "0.1", features = ["cudnn", "nvrtc", "replay"] }
4040
```
4141

4242
For the by-goal picker with transitive dep impact, see
4343
[`docs/features-matrix.md`](../../../docs/features-matrix.md).
4444

4545
### "trait `Actor` is not implemented"
4646

47-
You're using atomr 0.2 — the trait lives in `atomr_core::actor`.
47+
You're using atomr — the trait lives in `atomr_core::actor`.
4848
The cleanest import is the atomr-accel-cuda prelude, which
4949
re-exports the relevant traits:
5050

docs/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ crates/
330330

331331
## Status & roadmap
332332

333-
`F2 – F9 implemented + atomr 0.2 adoption complete.` The project's
333+
`F2 – F9 implemented + atomr adoption complete.` The project's
334334
internal phase plan is "F"-numbered (foundation phases F1 through
335335
F10):
336336

docs/features-matrix.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ workspace**. Reach for one without inheriting the others.
3838

3939
```toml
4040
[dependencies]
41-
atomr-accel = "0.0"
41+
atomr-accel = "0.1"
4242
```
4343

4444
Runtime cost: atomr-core + atomr-config + atomr-macros + cudarc +
@@ -48,8 +48,8 @@ tokio. cuBLAS is the always-on library; everything else is gated.
4848

4949
```toml
5050
[dependencies]
51-
atomr-accel = "0.0"
52-
atomr-accel-patterns = "0.0"
51+
atomr-accel = "0.1"
52+
atomr-accel-patterns = "0.1"
5353
```
5454

5555
Adds: nothing beyond the patterns crate itself.
@@ -58,7 +58,7 @@ Adds: nothing beyond the patterns crate itself.
5858

5959
```toml
6060
[dependencies]
61-
atomr-accel = { version = "0.0", features = ["nvrtc"] }
61+
atomr-accel = { version = "0.1", features = ["nvrtc"] }
6262
```
6363

6464
Adds: cudarc nvrtc bindings (zero new transitive deps; just unlocks
@@ -68,8 +68,8 @@ Adds: cudarc nvrtc bindings (zero new transitive deps; just unlocks
6868

6969
```toml
7070
[dependencies]
71-
atomr-accel = { version = "0.0", features = ["full-cuda"] }
72-
atomr-accel-train = "0.0"
71+
atomr-accel = { version = "0.1", features = ["full-cuda"] }
72+
atomr-accel-train = "0.1"
7373
```
7474

7575
`full-cuda` aggregate bundles cuDNN + cuFFT + cuRAND + cuSPARSE +
@@ -79,7 +79,7 @@ cuSOLVER + cuBLASLt + NVRTC + cuTENSOR + NCCL.
7979

8080
```toml
8181
[dependencies]
82-
atomr-accel = { version = "0.0", features = ["replay"] }
82+
atomr-accel = { version = "0.1", features = ["replay"] }
8383
```
8484

8585
Adds: atomr-persistence (Journal trait), serde, serde_json. The
@@ -91,7 +91,7 @@ on where you want events to land.
9191

9292
```toml
9393
[dependencies]
94-
atomr-accel = { version = "0.0", features = ["telemetry"] }
94+
atomr-accel = { version = "0.1", features = ["telemetry"] }
9595
```
9696

9797
Adds: atomr-telemetry. Run `atomr-dashboard` as a sidecar to
@@ -101,11 +101,11 @@ visualize.
101101

102102
```toml
103103
[dependencies]
104-
atomr-accel = { version = "0.0", features = ["full-cuda", "replay", "cluster", "streams", "telemetry"] }
105-
atomr-accel-patterns = "0.0"
106-
atomr-accel-train = "0.0"
107-
atomr-accel-agents = "0.0"
108-
atomr-accel-cuda-realtime = { version = "0.0", features = ["nvrtc"] }
104+
atomr-accel = { version = "0.1", features = ["full-cuda", "replay", "cluster", "streams", "telemetry"] }
105+
atomr-accel-patterns = "0.1"
106+
atomr-accel-train = "0.1"
107+
atomr-accel-agents = "0.1"
108+
atomr-accel-cuda-realtime = { version = "0.1", features = ["nvrtc"] }
109109
```
110110

111111
## Feature reference

docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ A ten-minute tour. By the end you'll have:
1212

1313
- Rust **1.78+** (workspace toolchain in `rust-toolchain.toml`).
1414
- A sibling clone of [atomr](../../atomr) at `../atomr` (path
15-
dependency, version 0.2.x).
15+
dependency, version 0.1.x).
1616
- Optional but recommended: an NVIDIA GPU plus the
1717
[CUDA Toolkit](https://developer.nvidia.com/cuda-toolkit) (driver
1818
+ libraries). Without these, the workspace still builds and unit

0 commit comments

Comments
 (0)