API ReferenceΒΆ
This section documents every public module in PROTEA at the symbol level. It is generated from source docstrings via Sphinx autodoc and is always in sync with the installed codebase.
The reference is organised into four pages:
- Core
The domain layer: the
Operationprotocol andOperationRegistry, shared HTTP utilities, KNN search backends, feature engineering functions, and all eight registered operations.- Infrastructure
The persistence and messaging layer: SQLAlchemy ORM models, session management, RabbitMQ publisher and consumer, and the configuration loader.
- HTTP API
The HTTP API: FastAPI application factory, all six routers, and a summary table of all 21 public endpoints.
- Workers
The execution layer:
BaseWorker(two-session job lifecycle), worker entry points, and theQueueConsumer/OperationConsumerdistinction.