Skip to content

Commit 2038628

Browse files
docs: prune the Ray backend from the docs — only document what is real
The Ray executor is a NotImplementedError skeleton, so it doesn't belong in user-facing docs. Removed docs/ray_backend.md ("planned interface"), the RayExecutor section of execution_backends.md, the Ray line in philosophy.md, the mkdocs nav entry, and the README [ray] extras row. Fixed the backend's error message that pointed at the deleted doc. (The skeleton class + [ray] extra remain in the code, now undocumented — a candidate for full removal.)
1 parent 870a12a commit 2038628

6 files changed

Lines changed: 5 additions & 97 deletions

File tree

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,6 @@ aet compare --suite targetgen --plots
9393
|---|---|---|
9494
| `[viz]` | matplotlib, numpy | the figures (`plot`, `plot-sessions`, `compare --plots`) |
9595
| `[tracking]` | mlflow, opentelemetry | MLflow dashboards + OTel tracing |
96-
| `[ray]` | ray | parallel sweep execution (backend is a skeleton — see docs) |
9796
| `[docs]` | mkdocs, mkdocstrings | build the docs site (`mkdocs serve`) |
9897
| `[dev]` | pytest, ruff | development |
9998
| `[all]` | all of the above | |

docs/execution_backends.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -27,31 +27,10 @@ class LocalExecutor(ExecutionBackend):
2727
return [fn(spec) for spec in specs]
2828
```
2929

30-
## RayExecutor (skeleton)
31-
32-
The Ray backend is a skeleton. It is not yet implemented. Any call to `submit` or `run_many` raises `NotImplementedError`.
33-
34-
```
35-
aet run-suite --suite targetgen --methods agent_v1 --seeds 1,2,3 --execution ray
36-
# raises: NotImplementedError — use --execution local
37-
```
38-
39-
Attempting to use `--execution ray` with `run-suite` will also raise `NotImplementedError` at the CLI level, before any run is started.
40-
41-
To install the Ray extra (for future use):
42-
43-
```
44-
pip install 'aet[ray]'
45-
```
46-
47-
The `RayExecutor` class will import `ray` at construction time and raise `AetError` if it is not installed, rather than at call time.
48-
49-
See `docs/ray_backend.md` for the planned interface.
50-
5130
## CLI Flag Reference
5231

5332
| Flag | Values | Default | Applies to |
5433
|------|--------|---------|------------|
55-
| `--execution` | `local`, `ray` | `local` | `init-run`, `validate`, `run-suite` |
34+
| `--execution` | `local` | `local` | `init-run`, `validate`, `run-suite` |
5635

57-
Use `--execution local` for all current work.
36+
The local executor is the only implemented backend.

docs/philosophy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The same principle applies to optional Python dependencies. `aet` has no require
3131
## What aet Is Not
3232

3333
- Not a training framework.
34-
- Not a job scheduler (Ray integration is planned but not yet active).
34+
- Not a job scheduler.
3535
- Not a dashboard (SigNoz is an optional viewer, not a dependency).
3636
- Not a replacement for your project's own test suite.
3737

docs/ray_backend.md

Lines changed: 0 additions & 67 deletions
This file was deleted.

mkdocs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ nav:
4545
- GenAI semconv: genai_semconv.md
4646
- SigNoz (optional): signoz_optional.md
4747
- Execution backends: execution_backends.md
48-
- Ray backend: ray_backend.md
4948
- Bundled suite (targetgen):
5049
- Overview: targetgen_suite.md
5150
- Metrics: targetgen_metrics.md

src/aet/execution/ray_backend.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,10 @@ def __init__(self, ray_address: str | None = None) -> None:
1919

2020
def submit(self, spec: RunSpec, fn: Callable) -> Any:
2121
raise NotImplementedError(
22-
"Ray execution backend is not yet implemented. Use --execution local.\n"
23-
"See docs/ray_backend.md for the planned interface."
22+
"Ray execution backend is not implemented. Use --execution local."
2423
)
2524

2625
def run_many(self, specs: list[RunSpec], fn: Callable) -> list[Any]:
2726
raise NotImplementedError(
28-
"Ray execution backend is not yet implemented. Use --execution local.\n"
29-
"See docs/ray_backend.md for the planned interface."
27+
"Ray execution backend is not implemented. Use --execution local."
3028
)

0 commit comments

Comments
 (0)