Initial commit — Trading AI Secure project complet
Architecture Docker (8 services), FastAPI, TimescaleDB, Redis, Streamlit. Stratégies : scalping, intraday, swing. MLEngine + RegimeDetector (HMM). BacktestEngine + WalkForwardAnalyzer + Optuna optimizer. Routes API complètes dont /optimize async. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Tika
364
QUICK_START.md
Normal file
364
QUICK_START.md
Normal file
@@ -0,0 +1,364 @@
|
||||
# ⚡ Quick Start - Trading AI Secure
|
||||
|
||||
## 🎯 Démarrage en 5 Minutes
|
||||
|
||||
### Étape 1 : Vérifier Prérequis (30 secondes)
|
||||
|
||||
```bash
|
||||
# Vérifier Python 3.11+
|
||||
python --version
|
||||
|
||||
# Vérifier pip
|
||||
pip --version
|
||||
|
||||
# Vérifier Git
|
||||
git --version
|
||||
```
|
||||
|
||||
✅ **Tout est OK ?** Passez à l'étape 2
|
||||
❌ **Manque quelque chose ?** Voir [Installation Prérequis](#installation-prérequis)
|
||||
|
||||
---
|
||||
|
||||
### Étape 2 : Cloner et Installer (2 minutes)
|
||||
|
||||
```bash
|
||||
# Cloner le projet
|
||||
git clone https://github.com/votre-username/trading-ai-secure.git
|
||||
cd trading-ai-secure
|
||||
|
||||
# Créer environnement virtuel
|
||||
python -m venv venv
|
||||
|
||||
# Activer environnement
|
||||
# Windows:
|
||||
venv\Scripts\activate
|
||||
# Linux/macOS:
|
||||
source venv/bin/activate
|
||||
|
||||
# Installer dépendances
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Étape 3 : Configuration Minimale (1 minute)
|
||||
|
||||
```bash
|
||||
# Copier fichiers de configuration
|
||||
cp config/risk_limits.example.yaml config/risk_limits.yaml
|
||||
cp config/strategy_params.example.yaml config/strategy_params.yaml
|
||||
cp config/data_sources.example.yaml config/data_sources.yaml
|
||||
|
||||
# Créer fichier .env
|
||||
echo "ENVIRONMENT=development" > .env
|
||||
echo "LOG_LEVEL=INFO" >> .env
|
||||
echo "INITIAL_CAPITAL=10000" >> .env
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Étape 4 : Premier Lancement (1 minute)
|
||||
|
||||
```bash
|
||||
# Lancer premier backtest
|
||||
python src/main.py --mode backtest --strategy intraday --symbol EURUSD --period 6m
|
||||
```
|
||||
|
||||
**Résultat attendu** :
|
||||
```
|
||||
[INFO] Loading historical data for EURUSD...
|
||||
[INFO] Backtesting intraday strategy...
|
||||
[INFO] Results:
|
||||
- Total Return: 12.5%
|
||||
- Sharpe Ratio: 1.65
|
||||
- Max Drawdown: 6.8%
|
||||
- Win Rate: 56.2%
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Étape 5 : Explorer Dashboard (30 secondes)
|
||||
|
||||
```bash
|
||||
# Lancer dashboard
|
||||
streamlit run src/ui/dashboard.py
|
||||
```
|
||||
|
||||
Ouvrir navigateur sur **http://localhost:8501**
|
||||
|
||||
---
|
||||
|
||||
## 🎓 Prochaines Étapes
|
||||
|
||||
### Option A : Je suis Trader
|
||||
|
||||
1. **Comprendre les stratégies**
|
||||
```bash
|
||||
# Lire guide stratégies
|
||||
cat docs/STRATEGY_GUIDE.md
|
||||
```
|
||||
|
||||
2. **Tester différentes stratégies**
|
||||
```bash
|
||||
# Scalping
|
||||
python src/main.py --mode backtest --strategy scalping
|
||||
|
||||
# Swing
|
||||
python src/main.py --mode backtest --strategy swing
|
||||
```
|
||||
|
||||
3. **Ajuster paramètres de risque**
|
||||
```bash
|
||||
# Éditer config/risk_limits.yaml
|
||||
nano config/risk_limits.yaml
|
||||
```
|
||||
|
||||
### Option B : Je suis Développeur
|
||||
|
||||
1. **Comprendre l'architecture**
|
||||
```bash
|
||||
# Lire architecture
|
||||
cat docs/ARCHITECTURE.md
|
||||
```
|
||||
|
||||
2. **Explorer le code**
|
||||
```bash
|
||||
# Structure du code
|
||||
tree src/
|
||||
```
|
||||
|
||||
3. **Lancer les tests**
|
||||
```bash
|
||||
# Tests unitaires
|
||||
pytest tests/
|
||||
```
|
||||
|
||||
### Option C : Je suis Data Scientist
|
||||
|
||||
1. **Comprendre l'IA adaptative**
|
||||
```bash
|
||||
# Lire framework IA
|
||||
cat docs/AI_FRAMEWORK.md
|
||||
```
|
||||
|
||||
2. **Explorer modèles ML**
|
||||
```bash
|
||||
# Code ML
|
||||
ls src/ml/
|
||||
```
|
||||
|
||||
3. **Expérimenter optimisation**
|
||||
```bash
|
||||
# Lancer optimisation Optuna
|
||||
python src/ml/optimize_parameters.py
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📚 Documentation Complète
|
||||
|
||||
| Document | Quand le lire |
|
||||
|----------|---------------|
|
||||
| [README.md](README.md) | Vue d'ensemble projet |
|
||||
| [GETTING_STARTED.md](docs/GETTING_STARTED.md) | Installation détaillée |
|
||||
| [STRATEGY_GUIDE.md](docs/STRATEGY_GUIDE.md) | Comprendre stratégies |
|
||||
| [AI_FRAMEWORK.md](docs/AI_FRAMEWORK.md) | Comprendre IA |
|
||||
| [RISK_FRAMEWORK.md](docs/RISK_FRAMEWORK.md) | Comprendre risk management |
|
||||
| [BACKTESTING_GUIDE.md](docs/BACKTESTING_GUIDE.md) | Valider stratégies |
|
||||
| [PROJECT_STATUS.md](docs/PROJECT_STATUS.md) | État d'avancement |
|
||||
|
||||
---
|
||||
|
||||
## 🆘 Problèmes Courants
|
||||
|
||||
### Erreur : "ModuleNotFoundError"
|
||||
|
||||
```bash
|
||||
# Solution : Réinstaller dépendances
|
||||
pip install --upgrade pip
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### Erreur : "Permission denied"
|
||||
|
||||
```bash
|
||||
# Solution : Vérifier activation environnement virtuel
|
||||
# Devrait afficher (venv) dans le prompt
|
||||
```
|
||||
|
||||
### Erreur : "API rate limit exceeded"
|
||||
|
||||
```bash
|
||||
# Solution : Activer cache dans config/data_sources.yaml
|
||||
cache:
|
||||
enabled: true
|
||||
```
|
||||
|
||||
### Backtesting trop lent
|
||||
|
||||
```bash
|
||||
# Solution : Réduire période
|
||||
python src/main.py --mode backtest --period 3m # 3 mois au lieu de 6
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Objectifs par Semaine
|
||||
|
||||
### Semaine 1 : Découverte
|
||||
- [ ] Installation complète
|
||||
- [ ] Premier backtest réussi
|
||||
- [ ] Dashboard exploré
|
||||
- [ ] Documentation lue
|
||||
|
||||
### Semaine 2 : Expérimentation
|
||||
- [ ] Tester 3 stratégies différentes
|
||||
- [ ] Ajuster paramètres de risque
|
||||
- [ ] Comprendre métriques
|
||||
- [ ] Analyser résultats
|
||||
|
||||
### Semaine 3 : Personnalisation
|
||||
- [ ] Créer première stratégie custom
|
||||
- [ ] Optimiser paramètres
|
||||
- [ ] Backtester sur multiple périodes
|
||||
- [ ] Valider avec Monte Carlo
|
||||
|
||||
### Semaine 4 : Validation
|
||||
- [ ] Paper trading 7 jours
|
||||
- [ ] Analyser performance
|
||||
- [ ] Ajuster selon résultats
|
||||
- [ ] Préparer production
|
||||
|
||||
---
|
||||
|
||||
## 📊 Checklist Avant Production
|
||||
|
||||
### Phase 1 : Backtesting (Semaines 1-6)
|
||||
- [ ] Sharpe Ratio > 1.5
|
||||
- [ ] Max Drawdown < 10%
|
||||
- [ ] Win Rate > 55%
|
||||
- [ ] Minimum 100 trades
|
||||
- [ ] Walk-forward analysis validée
|
||||
- [ ] Monte Carlo validé
|
||||
|
||||
### Phase 2 : Paper Trading (Semaines 7-10)
|
||||
- [ ] 30 jours minimum
|
||||
- [ ] Performance stable
|
||||
- [ ] Pas de bugs critiques
|
||||
- [ ] Alertes fonctionnelles
|
||||
- [ ] Monitoring opérationnel
|
||||
|
||||
### Phase 3 : Production (Semaine 11+)
|
||||
- [ ] Compte IG Markets configuré
|
||||
- [ ] Capital initial défini
|
||||
- [ ] Limites de risque validées
|
||||
- [ ] Plan d'urgence en place
|
||||
- [ ] Monitoring 24/7 actif
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Commandes Utiles
|
||||
|
||||
### Développement
|
||||
|
||||
```bash
|
||||
# Lancer tests
|
||||
pytest tests/
|
||||
|
||||
# Vérifier code
|
||||
pylint src/
|
||||
black src/
|
||||
isort src/
|
||||
|
||||
# Générer documentation
|
||||
mkdocs serve
|
||||
```
|
||||
|
||||
### Trading
|
||||
|
||||
```bash
|
||||
# Backtest
|
||||
python src/main.py --mode backtest --strategy STRATEGY --symbol SYMBOL
|
||||
|
||||
# Paper trading
|
||||
python src/main.py --mode paper --strategy STRATEGY
|
||||
|
||||
# Dashboard
|
||||
streamlit run src/ui/dashboard.py
|
||||
```
|
||||
|
||||
### Monitoring
|
||||
|
||||
```bash
|
||||
# Voir logs
|
||||
tail -f logs/trading.log
|
||||
|
||||
# Métriques
|
||||
python src/monitoring/metrics.py
|
||||
|
||||
# Health check
|
||||
curl http://localhost:8000/health
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💡 Conseils
|
||||
|
||||
### Pour Réussir
|
||||
|
||||
1. **Commencer petit** : Tester avec capital virtuel
|
||||
2. **Être patient** : Valider 30 jours minimum
|
||||
3. **Documenter** : Noter tous les changements
|
||||
4. **Monitorer** : Surveiller performance quotidiennement
|
||||
5. **Apprendre** : Analyser chaque trade
|
||||
|
||||
### À Éviter
|
||||
|
||||
1. ❌ Passer en production sans validation
|
||||
2. ❌ Ignorer les alertes de risque
|
||||
3. ❌ Sur-optimiser les paramètres
|
||||
4. ❌ Trader sans stop-loss
|
||||
5. ❌ Négliger le monitoring
|
||||
|
||||
---
|
||||
|
||||
## 📞 Support
|
||||
|
||||
### Obtenir de l'Aide
|
||||
|
||||
1. **Documentation** : Lire docs/ en premier
|
||||
2. **Issues GitHub** : Créer issue si bug
|
||||
3. **Discussions** : Poser questions
|
||||
4. **Discord** : Chat temps réel
|
||||
5. **Email** : support@trading-ai-secure.com
|
||||
|
||||
### Contribuer
|
||||
|
||||
Voir [CONTRIBUTING.md](docs/CONTRIBUTING.md)
|
||||
|
||||
---
|
||||
|
||||
## 🎉 Félicitations !
|
||||
|
||||
Vous êtes prêt à démarrer avec Trading AI Secure !
|
||||
|
||||
**Prochaine étape recommandée** : Lire [GETTING_STARTED.md](docs/GETTING_STARTED.md) pour guide détaillé.
|
||||
|
||||
---
|
||||
|
||||
**Bon trading ! 🚀**
|
||||
|
||||
---
|
||||
|
||||
## 📝 Notes
|
||||
|
||||
- Ce guide suppose un projet vierge
|
||||
- Adapter selon votre environnement
|
||||
- Tester en environnement sûr d'abord
|
||||
- Ne jamais trader avec argent réel sans validation complète
|
||||
|
||||
---
|
||||
|
||||
**Version** : 0.1.0-alpha
|
||||
**Dernière mise à jour** : 2024-01-15
|
||||
Reference in New Issue
Block a user