Auto-Generated API Reference¶
API documentation automatically generated from Python docstrings using mkdocstrings.
These pages are rendered directly from source code. When docstrings are updated in the codebase, the documentation here reflects those changes on the next build.
Pages¶
| Page | Contents |
|---|---|
| Common Entities | Strategy, BacktestConfig, BacktestResult, ConfigVersion, ExchangeConfig, ModelStage, JobStatus |
| Data Entities | DateRange, SymbolList, Timeframe, OHLCVData |
| Strategy Entities | TradAIStrategy, StrategyMetadata, StrategyCategory, validation types |
| Services & Base Classes | BaseService, Settings, LoggerMixin |
| AWS & Infrastructure | JobStatus, RetrainingStatus, ResilienceConfig |
| Adapters & Repositories | ArcticAdapter, MLflowAdapter, ConfigVersionService, ConfigMergeService |
How It Works¶
The module.Class directive renders the class docstring, method signatures, and type annotations directly from the source code. This ensures the API reference is always in sync with the implementation.
See also the SDK Reference for usage examples and conceptual guides alongside the auto-generated reference.