Skip to content
Maxime Grenu edited this page May 29, 2025 · 1 revision

Usage

Running the Trading Bot

Main Entry Point

python main.py
  • Launches the trading system using the configuration in config/ and your selected models.

Training Models

python training/train_models.py
  • Runs the training pipeline for ML and RL models.
  • Supports distributed training, checkpointing, and logging.

Running Backtests

python trading/scripts/run_backtest.py
  • Runs backtests using the built-in backtesting framework.
  • Results are visualized with matplotlib and exported in JSON.

API Server

python trading/api/app.py
  • Starts the REST API for bot control, monitoring, and external integration.
  • API documentation is available at /api/docs when running.

Monitoring & Dashboards

  • Console Dashboard: Real-time stats in terminal (utils/console_dashboard.py)
  • Grafana: Visual dashboards for metrics (set up via docker-compose)
  • Telegram Bot: Trade and error alerts (configure in .env)

Examples

  • Example strategies and scripts are provided in scripts/ and examples/.
  • See /docs for advanced usage and integration topics.

Refer to the README for more information on core components, configuration, and troubleshooting.

Clone this wiki locally