Files
NexQuant/examples/README.md
T
TPTBusiness b98c9cd572 feat: Add GitHub infrastructure, CI/CD pipelines, and examples
- Add GitHub issue templates (bug, feature, docs)
- Add pull request template with closed-source checklist
- Add CODEOWNERS for code review assignment
- Add CI/CD workflows (ci, lint, security, docs, release)
  - pytest + coverage with Python 3.10/3.11 matrix
  - Ruff + MyPy code quality checks
  - Bandit + safety security scanning
  - Sphinx docs + GitHub Pages deployment
  - Automated PyPI releases on tag push
- Add 6 comprehensive examples + Jupyter quickstart
  - 01_factor_discovery.py (LLM factor generation)
  - 02_factor_evolution.py (factor optimization)
  - 03_strategy_generation.py (IC-weighted combination)
  - 04_backtest_simple.py (strategy backtesting)
  - 05_model_training.py (XGBoost/LSTM training)
  - 06_rl_trading_agent.py (PPO/DQN/A2C agents)
  - notebooks/quickstart.ipynb (interactive tutorial)
- Restructure .gitignore with explicit closed-source sections
- Add CI/coverage/license badges to README
- Complete CLI docstrings for all 9 commands
- Add data_config.yaml for quant loop configuration
2026-04-11 21:40:18 +02:00

4.0 KiB

PREDIX Examples

Willkommen zu den PREDIX Trading Platform Beispielen! Dieser Ordner enthält vollständi ge, lauffä hige Beispiele, die dir den Einstieg in algorithmisches Trading mit EUR/USD erleichtern.

📚 Beispiele im Überblick

Nr. Beispiel Beschreibung Dauer Schwierigkeit
01 factor_discovery.py Automatische Generierung neuer Trading-Faktoren ~10 Min Anfänger
02 factor_evolution.py Optimierung bestehender Faktoren ~15 Min Mittel
03 strategy_generation.py Kombination von Faktoren zu Strategien ~5 Min Anfänger
04 backtest_simple.py Backtest einer Trading-Strategie ~3 Min Anfänger
05 model_training.py ML-Modell-Training (LSTM/XGBoost) ~30 Min Fortgeschritten
06 rl_trading_agent.py Reinforcement Learning Agent ~60 Min Fortgeschritten

🚀 Schnellstart

Voraussetzungen

# Installation
pip install -e ".[all]"

# Daten herunterladen (falls noch nicht geschehen)
rdagent download-data

Beispiel ausführen

# Faktor-Generierung (3 Loops)
python examples/01_factor_discovery.py --loop-n 3

# Backtest durchführen
python examples/04_backtest_simple.py --strategy momentum

📖 Detaillierte Anleitungen

Beispiel 01: Factor Discovery

Ziel: Automatisch neue Trading-Faktoren mit LLM generieren lassen

python examples/01_factor_discovery.py --loop-n 5 --llm local

Output:

  • Generierte Faktoren in RD-Agent_workspace/
  • Performance-Metriken (ARR, Sharpe, IC)
  • Faktor-Implementierungen als Python-Code

Nächste Schritte: → Siehe 02_factor_evolution.py um Faktoren zu optimieren

Beispiel 02: Factor Evolution

Ziel: Bestehende Faktoren mit Session/Regime Filters verbessern

python examples/02_factor_evolution.py --factor momentum_16 --improve session_filter

Output:

  • Verbesserte Faktoren mit Before/After-Vergleich
  • Metrik-Verbesserungen (ARR +X%, Sharpe +X.X)

Beispiel 03: Strategy Generation

Ziel: Mehrere Faktoren zu einer robusten Strategie kombinieren

python examples/03_strategy_generation.py --factors momentum_16,reversal,session_alpha

Output:

  • IC-weighted Faktor-Kombination
  • Signal-Verteilung (Long/Short/Neutral)

Beispiel 04: Backtest

Ziel: Backtest einer Trading-Strategie auf historischen Daten

python examples/04_backtest_simple.py --strategy momentum --start 2020-01-01 --end 2025-12-31

Output:

  • Key-Metriken: ARR, Sharpe, MaxDD, WinRate
  • Equity Curve (optional als Plot)

Beispiel 05: Model Training

Ziel: ML-Modell (LSTM/XGBoost) auf Faktor-Daten trainieren

python examples/05_model_training.py --model lstm --features momentum_16,reversal

Output:

  • Trainiertes Modell in models/
  • Train/Val/Test Split Ergebnisse
  • Feature Importance (bei XGBoost)

Beispiel 06: RL Trading Agent

Ziel: Reinforcement Learning Agent für Trading trainieren

python examples/06_rl_trading_agent.py --algo ppo --episodes 1000

Output:

  • Trainierter RL-Agent in models/rl_agent/
  • Learning Curve
  • Trading-Statistiken

📓 Jupyter Notebook

Für eine interaktive Einführung siehe:

jupyter notebook examples/notebooks/quickstart.ipynb

🐛 Probleme?

⚠️ Wichtige Hinweise

  • Keine Closed-Source Assets: Commite niemals git_ignore_folder/, results/, .env, models/local/, prompts/local/
  • Daten-Pfade: Passe ggf. Datenpfade in den Beispielen an deine Installation an
  • Laufzeit: ML/RL-Beispiele benötigen ggf. GPU für akzeptable Laufzeiten