Source: EveryO 6c05a06. This page preserves the reviewed upstream guide and adds learning context. Version-specific headings and historical wording remain visible; boundary notes explain newer APIs separately.
BEFORE YOU BEGIN
Diagnose one boundary at a time.
Start with the interpreter and environment, then the numerical inputs, then the optional backend. Keep the smallest example that reproduces the problem.
- Environment: activate the intended virtual environment and install with that interpreter.
- Core numerics: run
everyo doctorbefore diagnosing a larger model. - Inputs: inspect shapes, dtypes, labels, and the loss contract.
- Optional components: test the CPU baseline before adding CUDA, TensorFlow, or ONNX.
- Report: reduce the failing case and include versions and commands without private data.
Run commands from the repository root with the virtual environment activated.
Use python -m pip to install into the same interpreter used by your examples.
Verify the environment
python -m pip install -e .
everyo info
everyo doctor
info reports versions and available backends. doctor also performs a core
gradient check. Missing TensorFlow or CUDA is expected in a CPU installation.
An optional backend being detected does not establish its numerical correctness
on your hardware; run the relevant tests before relying on it.
Common problems
| Symptom | Next step |
|---|---|
everyo command not found |
Activate the environment and repeat the editable installation. |
pytest is unavailable |
Install development dependencies with python -m pip install -e ".[dev]". |
| CUDA is unavailable | Follow CUDA setup; the core CPU path does not require the native extension. |
| ONNX import fails | Install python -m pip install -e ".[onnx]" in the active environment. |
| Charts cannot open a window | Save charts to files; headless execution uses the Agg backend. |
| Distributed example runs slowly | Limit BLAS worker threads as described in the example catalog. |
Machine-readable reports
everyo info --json
everyo benchmark --sizes 32 --repeats 1 --json --output artifacts/benchmark.json
With --json, benchmark stdout contains only the JSON result. When --output
is also supplied, the file confirmation goes to stderr so stdout can be piped
to another program. Timing results depend on hardware, load, and backend;
retain the environment report alongside measurements.
Report a reproducible problem
Include the EveryO version or commit, operating system, command, traceback,
and a small example using generated data. Include relevant everyo info
output after reviewing it for information you do not want to share publicly.
Use Support for help and Security for private
vulnerability reporting.
Original guide reproduced under the project’s MIT license. Upstream source remains authoritative.
View the reviewed source on GitHub ↗