|
1 | | -"""QuantTradeAI |
2 | | -================= |
3 | | -
|
4 | | -High-level interface for the QuantTradeAI toolkit. The package bundles |
5 | | -data acquisition, feature engineering, model training and backtesting |
6 | | -utilities for quantitative trading research. |
7 | | -
|
8 | | -Public API: |
9 | | - - ``DataSource`` and concrete implementations |
10 | | - - ``DataLoader`` and ``DataProcessor`` |
11 | | - - ``MomentumClassifier`` model |
12 | | - - ``PortfolioManager`` and risk helpers |
13 | | - - ``simulate_trades`` and ``compute_metrics`` for backtesting |
14 | | -
|
15 | | -Quick Start: |
16 | | - ```python |
17 | | - from quanttradeai import DataLoader, DataProcessor, MomentumClassifier |
18 | | -
|
19 | | - loader = DataLoader() |
20 | | - data = loader.fetch_data() |
21 | | - processor = DataProcessor() |
22 | | - processed = {s: processor.process_data(df) for s, df in data.items()} |
23 | | - model = MomentumClassifier() |
24 | | - ``` |
25 | | -""" |
26 | | - |
27 | | -from .data.datasource import ( |
28 | | - DataSource, |
29 | | - YFinanceDataSource, |
30 | | - AlphaVantageDataSource, |
31 | | - WebSocketDataSource, |
32 | | -) |
33 | | - |
34 | | -# Lazily import optional dependencies to keep lightweight usage possible |
35 | | -from .data.loader import DataLoader |
36 | | -from .data.processor import DataProcessor |
37 | | - |
38 | | -try: # pragma: no cover - optional heavy dependency |
39 | | - from .models.classifier import MomentumClassifier |
40 | | -except Exception: # pragma: no cover - tolerate missing ML libs |
41 | | - MomentumClassifier = None # type: ignore[assignment] |
42 | | -from .trading.portfolio import PortfolioManager |
43 | | -from .trading.risk import apply_stop_loss_take_profit, position_size |
44 | | -from .backtest import ( |
45 | | - simulate_trades, |
46 | | - compute_metrics, |
47 | | - MarketImpactModel, |
48 | | - LinearImpactModel, |
49 | | - SquareRootImpactModel, |
50 | | - AlmgrenChrissModel, |
51 | | - ImpactCalculator, |
52 | | -) |
53 | | - |
54 | | -__all__ = [ |
55 | | - "DataSource", |
56 | | - "YFinanceDataSource", |
57 | | - "AlphaVantageDataSource", |
58 | | - "WebSocketDataSource", |
59 | | - "DataLoader", |
60 | | - "DataProcessor", |
61 | | - "MomentumClassifier", |
62 | | - "PortfolioManager", |
63 | | - "apply_stop_loss_take_profit", |
64 | | - "position_size", |
65 | | - "simulate_trades", |
66 | | - "compute_metrics", |
67 | | - "MarketImpactModel", |
68 | | - "LinearImpactModel", |
69 | | - "SquareRootImpactModel", |
70 | | - "AlmgrenChrissModel", |
71 | | - "ImpactCalculator", |
72 | | -] |
| 1 | +"""QuantTradeAI |
| 2 | +================= |
| 3 | +
|
| 4 | +High-level interface for the QuantTradeAI toolkit. The package bundles |
| 5 | +data acquisition, feature engineering, model training and backtesting |
| 6 | +utilities for quantitative trading research. |
| 7 | +
|
| 8 | +Public API: |
| 9 | + - ``DataSource`` and concrete implementations |
| 10 | + - ``DataLoader`` and ``DataProcessor`` |
| 11 | + - ``MomentumClassifier`` model |
| 12 | + - ``PortfolioManager`` and risk helpers |
| 13 | + - ``simulate_trades`` and ``compute_metrics`` for backtesting |
| 14 | +
|
| 15 | +Quick Start: |
| 16 | + ```python |
| 17 | + from quanttradeai import DataLoader, DataProcessor, MomentumClassifier |
| 18 | +
|
| 19 | + loader = DataLoader() |
| 20 | + data = loader.fetch_data() |
| 21 | + processor = DataProcessor() |
| 22 | + processed = {s: processor.process_data(df) for s, df in data.items()} |
| 23 | + model = MomentumClassifier() |
| 24 | + ``` |
| 25 | +""" |
| 26 | + |
| 27 | +from .data.datasource import ( |
| 28 | + DataSource, |
| 29 | + YFinanceDataSource, |
| 30 | + AlphaVantageDataSource, |
| 31 | + WebSocketDataSource, |
| 32 | +) |
| 33 | + |
| 34 | +# Lazily import optional dependencies to keep lightweight usage possible |
| 35 | +from .data.loader import DataLoader |
| 36 | +from .data.processor import DataProcessor |
| 37 | + |
| 38 | +try: # pragma: no cover - optional heavy dependency |
| 39 | + from .models.classifier import MomentumClassifier |
| 40 | +except Exception: # pragma: no cover - tolerate missing ML libs |
| 41 | + MomentumClassifier = None # type: ignore[assignment] |
| 42 | +from .trading.portfolio import PortfolioManager |
| 43 | +from .trading.risk import apply_stop_loss_take_profit, position_size |
| 44 | +from .backtest import ( |
| 45 | + simulate_trades, |
| 46 | + compute_metrics, |
| 47 | + MarketImpactModel, |
| 48 | + LinearImpactModel, |
| 49 | + SquareRootImpactModel, |
| 50 | + AlmgrenChrissModel, |
| 51 | + ImpactCalculator, |
| 52 | + DynamicSpreadModel, |
| 53 | + BacktestEngine, |
| 54 | +) |
| 55 | + |
| 56 | +__all__ = [ |
| 57 | + "DataSource", |
| 58 | + "YFinanceDataSource", |
| 59 | + "AlphaVantageDataSource", |
| 60 | + "WebSocketDataSource", |
| 61 | + "DataLoader", |
| 62 | + "DataProcessor", |
| 63 | + "MomentumClassifier", |
| 64 | + "PortfolioManager", |
| 65 | + "apply_stop_loss_take_profit", |
| 66 | + "position_size", |
| 67 | + "simulate_trades", |
| 68 | + "compute_metrics", |
| 69 | + "MarketImpactModel", |
| 70 | + "LinearImpactModel", |
| 71 | + "SquareRootImpactModel", |
| 72 | + "AlmgrenChrissModel", |
| 73 | + "ImpactCalculator", |
| 74 | + "DynamicSpreadModel", |
| 75 | + "BacktestEngine", |
| 76 | +] |
0 commit comments