# alimohammadiamirhossein/cryptopredictions architecture

> Architecture diagram of the GitHub repository alimohammadiamirhossein/cryptopredictions, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-11-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/alimohammadiamirhossein/cryptopredictions
- Repository: https://github.com/alimohammadiamirhossein/cryptopredictions

## Overview

##### Project type and purpose
- CryptoPredictions is an open-source Python toolbox for time-series forecasting and backtesting on cryptocurrency price data.
- It provides a unified training pipeline (train.py), a backtesting engine (backtester.py), and a battery of models (ARIMA, LSTM, GRU, XGBoost, Prophet, etc.) all configured via Hydra.

##### File structure
- Entry points:
– train.py → kicks off factory.trainer
– backtester.py → runs factory.profit_calculator with user-defined strategies
- Configuration:
– configs/hydra/… holds YAML files grouping dataset loader, model, training, backtest, and metrics settings
- Data ingestion and feature engineering:
– data_loader/Bitmex.py, CoinMarketDataset.py, indicators.py
- Model implementations:
– models/*.py (GRU, LSTM, arima, xgboost, etc.)
- Orchestration:
– factory/trainer.py, evaluator.py, profit_calculator.py
- Metrics and reporting:
– metrics/metrics.py, utils/average_meter.py, utils/reporter.py

##### README for additional insights
- Hydra config structure is central—drive both training and backtesting runs via hierarchical YAML overrides.
- Data comes as CSV files in data/ and is enriched with 30+ computed indicators.
- Results and reporting rely on standardized metrics (MAE, RMSE, accuracy, etc.) and visualizations.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Configuration Layer
    subgraph "Configuration Layer"
        direction TB
        ConfigManager["Configuration Manager (Hydra)"]:::config
        LoggingConfig["Logging Config"]:::config
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        DataSource[(CSV Data Files)]:::data
        subgraph "Data Loader & Indicator Processor"
            direction TB
            Bitmex["Bitmex Loader"]:::data
            CoinMarketDataset["CoinMarketDataset"]:::data
            Indicators["Indicator Processor"]:::data
            Creator["Dataset Creator"]:::data
        end
    end

    %% Compute Layer
    subgraph "Compute Layer"
        direction TB
        subgraph "Model Training Pipeline"
            direction TB
            TrainEntry["train.py"]:::compute
            Trainer["Factory Trainer"]:::compute
            subgraph "Models"
                direction TB
                GRU["GRU Model"]:::compute
                LSTM["LSTM Model"]:::compute
                ARIMA["ARIMA Model"]:::compute
                XGBoost["XGBoost Model"]:::compute
                Prophet["Prophet Model"]:::compute
                NeuralProphet["NeuralProphet"]:::compute
                Orbit["Orbit Model"]:::compute
                RandomForest["RandomForest Model"]:::compute
                SARIMAX["SARIMAX Model"]:::compute
            end
        end
        subgraph "Evaluation & Metrics"
            direction TB
            Evaluator["Factory Evaluator"]:::compute
            Metrics["Metrics Module"]:::compute
            AvgMeter["Average Meter"]:::compute
        end
        subgraph "Backtesting Engine"
            direction TB
            BacktesterEntry["backtester.py"]:::compute
            ProfitCalc["Factory Profit Calculator"]:::compute
            Strategies["Strategies"]:::compute
        end
    end

    %% Reporting Layer
    subgraph "Reporting & Logging"
        direction TB
        Reporter["Reporter"]:::report
        PathDef["Path Definitions"]:::report
    end

    %% Relationships
    ConfigManager -.->|provides configs| Bitmex
    ConfigManager -.->|provides configs| Trainer
    ConfigManager -.->|provides configs| BacktesterEntry
    LoggingConfig -.->|logging| Reporter

    DataSource -->|reads data| Bitmex
    Bitmex -->|raw data| CoinMarketDataset
    CoinMarketDataset -->|dataframe| Indicators
    Indicators -->|features| Creator
    Creator -->|dataset| Trainer

    Trainer -->|instantiates| GRU
    Trainer -->|instantiates| LSTM
    Trainer -->|instantiates| ARIMA
    Trainer -->|instantiates| XGBoost
    Trainer -->|instantiates| Prophet
    Trainer -->|instantiates| NeuralProphet
    Trainer -->|instantiates| Orbit
    Trainer -->|instantiates| RandomForest
    Trainer -->|instantiates| SARIMAX
    Trainer -->|trains| GRU
    Trainer -->|trains| LSTM
    Trainer -->|trains| ARIMA
    Trainer -->|trains| XGBoost
    Trainer -->|trains| Prophet
    Trainer -->|trains| NeuralProphet
    Trainer -->|trains| Orbit
    Trainer -->|trains| RandomForest
    Trainer -->|trains| SARIMAX

    Trainer -->|predictions| Evaluator
    Evaluator -->|metrics| Metrics
    Metrics -->|averages| AvgMeter
    Evaluator -->|results| Reporter

    Trainer -->|predictions| BacktesterEntry
    Strategies -->|defines| ProfitCalc
    ProfitCalc -->|simulates| BacktesterEntry
    BacktesterEntry -->|P&L| Reporter

    %% Click Events
    click ConfigManager "https://github.com/alimohammadiamirhossein/cryptopredictions/tree/main/configs/hydra/"
    click LoggingConfig "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/configs/logging.conf"
    click DataSource "https://github.com/alimohammadiamirhossein/cryptopredictions/tree/main/data/"
    click Bitmex "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/data_loader/Bitmex.py"
    click CoinMarketDataset "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/data_loader/CoinMarketDataset.py"
    click Indicators "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/data_loader/indicators.py"
    click Creator "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/data_loader/creator.py"
    click TrainEntry "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/train.py"
    click Trainer "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/factory/trainer.py"
    click GRU "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/models/GRU.py"
    click LSTM "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/models/LSTM.py"
    click ARIMA "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/models/arima.py"
    click XGBoost "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/models/xgboost.py"
    click Prophet "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/models/prophet.py"
    click NeuralProphet "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/models/neural_prophet.py"
    click Orbit "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/models/orbit.py"
    click RandomForest "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/models/random_forest.py"
    click SARIMAX "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/models/sarimax.py"
    click Evaluator "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/factory/evaluator.py"
    click Metrics "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/metrics/metrics.py"
    click AvgMeter "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/utils/average_meter.py"
    click BacktesterEntry "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/backtester.py"
    click ProfitCalc "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/factory/profit_calculator.py"
    click Strategies "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/backtest/strategies.py"
    click Reporter "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/utils/reporter.py"
    click PathDef "https://github.com/alimohammadiamirhossein/cryptopredictions/blob/main/path_definition.py"

    %% Styles
    classDef config fill:#CCF,stroke:#000,stroke-width:1px;
    classDef data fill:#CFC,stroke:#000,stroke-width:1px;
    classDef compute fill:#FFC,stroke:#000,stroke-width:1px;
    classDef report fill:#FCC,stroke:#000,stroke-width:1px;
```
