tika/trader-ml
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
trader-ml/DOCUMENTATION_INDEX.md
Tika da30ef19ed 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>
2026-03-08 17:38:09 +00:00

321 lines
10 KiB
Markdown
Raw Permalink Blame History

# 📚 Index de la Documentation - Trading AI Secure
## 🎯 Vue d'ensemble
Bienvenue dans la documentation complète de **Trading AI Secure**, une plateforme de trading algorithmique avec IA adaptative et risk management intégré.
---
## 📖 Documentation Principale
### 1. Démarrage Rapide
| Document | Description | Audience |
|----------|-------------|----------|
| [README.md](README.md) | Vue d'ensemble du projet | Tous |
| [GETTING_STARTED.md](docs/GETTING_STARTED.md) | Guide d'installation et premier lancement | Débutants |
| [PROJECT_STATUS.md](docs/PROJECT_STATUS.md) | État d'avancement détaillé | Tous |
### 2. Architecture et Conception
| Document | Description | Audience |
|----------|-------------|----------|
| [ARCHITECTURE.md](docs/ARCHITECTURE.md) | Architecture technique détaillée | Développeurs |
| [AI_FRAMEWORK.md](docs/AI_FRAMEWORK.md) | Framework IA adaptative | Data Scientists |
| [RISK_FRAMEWORK.md](docs/RISK_FRAMEWORK.md) | Système de risk management | Traders, Développeurs |
### 3. Stratégies et Trading
| Document | Description | Audience |
|----------|-------------|----------|
| [STRATEGY_GUIDE.md](docs/STRATEGY_GUIDE.md) | Guide des stratégies de trading | Traders, Développeurs |
| [BACKTESTING_GUIDE.md](docs/BACKTESTING_GUIDE.md) | Guide de backtesting anti-overfitting | Quants, Développeurs |
### 4. Intégration et Déploiement
| Document | Description | Audience |
|----------|-------------|----------|
| [IG_INTEGRATION.md](docs/IG_INTEGRATION.md) | Intégration IG Markets | Développeurs |
| [CONTRIBUTING.md](docs/CONTRIBUTING.md) | Guide de contribution | Contributeurs |
---
## ⚙️ Configuration
### Fichiers de Configuration
| Fichier | Description | Statut |
|---------|-------------|--------|
| `config/risk_limits.example.yaml` | Limites de risque (template) | ✅ Créé |
| `config/strategy_params.example.yaml` | Paramètres stratégies (template) | ✅ Créé |
| `config/data_sources.example.yaml` | Sources de données (template) | ✅ Créé |
| `config/ig_config.yaml` | Credentials IG Markets | ⚠️ À créer manuellement |
### Variables d'Environnement
```bash
# .env (à créer)
ENVIRONMENT=development
LOG_LEVEL=INFO
INITIAL_CAPITAL=10000
ENCRYPTION_KEY=your_encryption_key_here
```
---
## 🗂️ Structure du Projet
```
trading_ai_secure/
├── README.md # Vue d'ensemble
├── DOCUMENTATION_INDEX.md # Ce fichier
├── requirements.txt # Dépendances Python
├── .env.example # Template variables d'environnement
│
├── docs/ # Documentation
│ ├── GETTING_STARTED.md # Guide démarrage
│ ├── PROJECT_STATUS.md # État d'avancement
│ ├── ARCHITECTURE.md # Architecture technique
│ ├── AI_FRAMEWORK.md # Framework IA
│ ├── RISK_FRAMEWORK.md # Risk management
│ ├── STRATEGY_GUIDE.md # Guide stratégies
│ ├── BACKTESTING_GUIDE.md # Guide backtesting
│ ├── IG_INTEGRATION.md # Intégration IG
│ └── CONTRIBUTING.md # Guide contribution
│
├── config/ # Configurations
│ ├── risk_limits.example.yaml # Limites risque (template)
│ ├── strategy_params.example.yaml # Paramètres stratégies (template)
│ ├── data_sources.example.yaml # Sources données (template)
│ └── ig_config.yaml # Credentials IG (à créer)
│
├── src/ # Code source (à créer)
│ ├── core/ # Modules core
│ ├── strategies/ # Stratégies trading
│ ├── ml/ # Machine learning
│ ├── data/ # Connecteurs données
│ ├── backtesting/ # Framework backtesting
│ └── ui/ # Interface utilisateur
│
├── tests/ # Tests (à créer)
│ ├── unit/ # Tests unitaires
│ ├── integration/ # Tests intégration
│ └── e2e/ # Tests end-to-end
│
├── logs/ # Logs (généré)
├── data/ # Données (généré)
└── .git/ # Git repository
```
---
## 🚀 Parcours d'Apprentissage
### Pour Débutants
1. **Jour 1-2** : Comprendre le projet
- Lire [README.md](README.md)
- Lire [GETTING_STARTED.md](docs/GETTING_STARTED.md)
- Installer environnement
2. **Jour 3-5** : Découvrir les stratégies
- Lire [STRATEGY_GUIDE.md](docs/STRATEGY_GUIDE.md)
- Lancer premier backtest
- Explorer dashboard
3. **Semaine 2** : Approfondir
- Lire [RISK_FRAMEWORK.md](docs/RISK_FRAMEWORK.md)
- Lire [AI_FRAMEWORK.md](docs/AI_FRAMEWORK.md)
- Expérimenter paramètres
### Pour Développeurs
1. **Jour 1** : Architecture
- Lire [ARCHITECTURE.md](docs/ARCHITECTURE.md)
- Comprendre flux de données
- Setup environnement dev
2. **Jour 2-3** : Code
- Lire [CONTRIBUTING.md](docs/CONTRIBUTING.md)
- Explorer code source
- Lancer tests
3. **Semaine 2** : Contribution
- Créer première feature
- Soumettre PR
- Review code
### Pour Traders
1. **Jour 1** : Stratégies
- Lire [STRATEGY_GUIDE.md](docs/STRATEGY_GUIDE.md)
- Comprendre indicateurs
- Tester stratégies
2. **Jour 2-3** : Risk Management
- Lire [RISK_FRAMEWORK.md](docs/RISK_FRAMEWORK.md)
- Configurer limites
- Comprendre circuit breakers
3. **Semaine 2** : Backtesting
- Lire [BACKTESTING_GUIDE.md](docs/BACKTESTING_GUIDE.md)
- Valider stratégies
- Analyser métriques
### Pour Data Scientists
1. **Jour 1** : IA Adaptative
- Lire [AI_FRAMEWORK.md](docs/AI_FRAMEWORK.md)
- Comprendre optimisation
- Explorer modèles ML
2. **Jour 2-3** : Implémentation
- Étudier code ML
- Tester optimisation Optuna
- Expérimenter features
3. **Semaine 2** : Amélioration
- Créer nouveaux modèles
- Optimiser pipeline
- Valider performance
---
## 📊 Métriques de Documentation
### Couverture Documentation
| Module | Documentation | Exemples | Tests Docs |
|--------|---------------|----------|------------|
| Core | ✅ 100% | ✅ Oui | ⏳ En cours |
| Stratégies | ✅ 100% | ✅ Oui | ⏳ En cours |
| ML/IA | ✅ 100% | ✅ Oui | ⏳ En cours |
| Risk | ✅ 100% | ✅ Oui | ⏳ En cours |
| Data | ✅ 100% | ✅ Oui | ⏳ En cours |
| Backtesting | ✅ 100% | ✅ Oui | ⏳ En cours |
| UI | ⏳ En cours | ⏳ En cours | ❌ Non |
### Statistiques
- **Pages de documentation** : 10
- **Lignes de documentation** : ~15,000
- **Exemples de code** : 50+
- **Diagrammes** : 15+
- **Fichiers de configuration** : 4
---
## 🔍 Recherche Rapide
### Par Sujet
#### Installation
- [Guide d'installation](docs/GETTING_STARTED.md#installation)
- [Configuration](docs/GETTING_STARTED.md#configuration)
- [Dépendances](requirements.txt)
#### Stratégies
- [Vue d'ensemble stratégies](docs/STRATEGY_GUIDE.md#vue-densemble)
- [Scalping](docs/STRATEGY_GUIDE.md#scalping-strategy)
- [Intraday](docs/STRATEGY_GUIDE.md#intraday-strategy)
- [Swing](docs/STRATEGY_GUIDE.md#swing-strategy)
#### IA et ML
- [IA adaptative](docs/AI_FRAMEWORK.md#philosophie-de-lia-auto-optimisante)
- [Optimisation paramètres](docs/AI_FRAMEWORK.md#optimisation-continue-des-paramètres)
- [Regime detection](docs/AI_FRAMEWORK.md#regime-detection)
#### Risk Management
- [Limites de risque](docs/RISK_FRAMEWORK.md#limites-et-contraintes)
- [Circuit breakers](docs/RISK_FRAMEWORK.md#circuit-breakers)
- [Validation pré-trade](docs/RISK_FRAMEWORK.md#validation-pré-trade)
#### Backtesting
- [Walk-forward analysis](docs/BACKTESTING_GUIDE.md#walk-forward-analysis)
- [Monte Carlo](docs/BACKTESTING_GUIDE.md#monte-carlo-simulation)
- [Paper trading](docs/BACKTESTING_GUIDE.md#paper-trading)
#### IG Markets
- [Configuration compte](docs/IG_INTEGRATION.md#configuration-compte)
- [API REST](docs/IG_INTEGRATION.md#api-rest)
- [Streaming](docs/IG_INTEGRATION.md#streaming-lightstreamer)
---
## 🆘 Support et Aide
### Problèmes Courants
| Problème | Solution | Documentation |
|----------|----------|---------------|
| Installation échoue | Voir troubleshooting | [GETTING_STARTED.md](docs/GETTING_STARTED.md#troubleshooting) |
| API rate limit | Configurer cache | [data_sources.yaml](config/data_sources.example.yaml) |
| Backtesting lent | Optimiser paramètres | [BACKTESTING_GUIDE.md](docs/BACKTESTING_GUIDE.md) |
| Erreur IG API | Vérifier credentials | [IG_INTEGRATION.md](docs/IG_INTEGRATION.md) |
### Obtenir de l'Aide
1. **Documentation** : Chercher dans docs/
2. **Issues GitHub** : Créer issue si bug
3. **Discussions** : Poser questions
4. **Discord** : Chat communauté
5. **Email** : support@trading-ai-secure.com
---
## 📅 Mises à Jour
### Dernières Mises à Jour
| Date | Document | Changements |
|------|----------|-------------|
| 2024-01-15 | Tous | Création documentation initiale |
| 2024-01-15 | PROJECT_STATUS.md | État d'avancement Phase 1 |
### Prochaines Mises à Jour
- [ ] Tutoriels vidéo
- [ ] API Reference complète
- [ ] Exemples avancés
- [ ] Traductions (FR, ES, DE)
---
## 🤝 Contribuer à la Documentation
### Comment Contribuer
1. Identifier lacune documentation
2. Créer issue "docs: ..."
3. Fork repository
4. Ajouter/modifier documentation
5. Soumettre PR
### Standards Documentation
- **Format** : Markdown
- **Style** : Clair, concis, exemples
- **Structure** : Table des matières, sections
- **Code** : Blocs de code avec syntaxe
- **Diagrammes** : ASCII art ou Mermaid
Voir [CONTRIBUTING.md](docs/CONTRIBUTING.md) pour détails.
---
## 📝 Licence
Ce projet est sous licence MIT. Voir [LICENSE](LICENSE) pour détails.
---
## 🙏 Remerciements
Merci à tous les contributeurs qui ont aidé à créer cette documentation complète !
---
**Documentation maintenue par l'équipe Trading AI Secure**
**Dernière mise à jour** : 2024-01-15
**Version** : 0.1.0-alpha
Reference in New Issue View Git Blame Copy Permalink