Quick start by dependency profile¶
The package always installs the required dependencies in project.dependencies.
The core, runtime, and full extras add task-specific dependencies defined in
pyproject.toml; they are not separate distributions.
Choose a profile¶
| Profile | Package semantics | Expected directories | Typical use |
|---|---|---|---|
core |
Base package plus configuration, validation, CLI, and parsing extras | Configuration, CLI, and parser modules under src/; configs/ |
CLI use, configuration, code analysis, offline-oriented work |
runtime |
Base package plus data/ML, RAG, serving, telemetry, and database extras | src/codex_ml/, src/rag/, src/mcp/, services/ |
Inference, retrieval, embeddings, and API services |
full |
Core/runtime capabilities plus test, quality, training, evaluation, tracking, and plugin tools | All src/ packages, tests/, configs/, notebooks/ |
Repository development, training, evaluation, and experiments |
core is lightweight relative to the ML profiles, but it still installs the package's
required base dependencies. runtime contains inference and serving libraries.
full is the contributor profile because it includes pytest, nox, Ruff, Black, isort,
mypy, and pre-commit.
Common environment setup¶
On Windows, activate with .venv\Scripts\activate.
Contributor setup¶
Start with contributor onboarding. Use focused tests while developing, then run the repository's documented pre-commit and nox gates.
ML work setup¶
For inference, serving, or RAG work:
For training, evaluation, experiment tracking, or ML development:
Start with ML engineer onboarding. CI-facing tests must be offline-safe; use local fixtures or mocks rather than downloading models or datasets.
CI and workflow maintenance setup¶
Start with GitHub Actions maintainer onboarding
and the workflow map. Workflow work commonly uses the quality tools
from full even when it does not exercise ML features.
Verify the selected environment¶
The package metadata in pyproject.toml is authoritative when another guide disagrees
with profile contents or version requirements.