# mwasifanwar/industrialprognosisai architecture

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

- Interactive diagram: https://gitdiagram.com/mwasifanwar/industrialprognosisai
- Repository: https://github.com/mwasifanwar/industrialprognosisai

## Overview

##### Project Type & Purpose
- This is a Python-based Machine Learning framework for condition monitoring and Remaining Useful Life (RUL) prediction of industrial equipment.
- Key features: data ingestion & preprocessing, feature engineering, model definition (CNN and others), training (cross-validation, HPO), evaluation (metrics, explainability, visualization).

##### File Structure & README
- Top-level directories:
- configs/ → YAML config files for model and experiment settings
- src/data → data loading, preprocessing, feature engineering
- src/models → model classes, factory for dynamic instantiation
- src/training → orchestration of training, cross-validation, hyperparameter tuning
- src/evaluation → post-training metrics, explainability modules, visualization
- src/utils → shared utilities: config parser, logger
- Build scripts & metadata: pyproject.toml, setup.py, requirements.txt indicate a Python package.

##### Main Components & Their Responsibilities
- Configuration Manager
- Loads and validates configs from configs/*.yaml
- Makes settings available to all modules via src/utils/config.py
- Data Layer
- DataLoader: reads raw datasets
- Preprocessor: cleans, normalizes data
- FeatureEngineer: derives features for RUL prediction
- Model Layer
- BaseModel: abstract interface
- CNNModel (and others): concrete deep-learning models
- ModelFactory: instantiates the right model based on config
- Training Orchestrator
- Trainer: executes standard training loop (forward, loss, backward)
- CrossValidation: splits data, runs multiple folds
- HyperparameterTuning: searches over hyperparameter space
- Evaluation Suite
- Metrics: computes performance metrics (MAE, RMSE, etc.)
- Explainability: SHAP, saliency maps or similar
- Visualization: plots training logs, metrics, explainability outputs
- Utilities
- Logger: structured logging of runs, errors, metrics
- Shared helpers

##### Relationships & Data Flow
- Start → Configuration Manager loads YAML → passes settings to all components
- Data Layer reads raw data → outputs processed feature matrices
- Training Orchestrator requests model from ModelFactory → trains on processed data
- Trained model → passed to Evaluation Suite → metrics & visual artifacts generated
- Logger records progress, hyperparameters, metrics at every stage

##### Architectural Patterns & Design Principles
- Layered architecture: clear separation of concerns (Data → Model → Training → Evaluation)
- Factory Pattern: dynamic model instantiation
- Pipeline Pattern: sequential data transformations (loading → preprocessing → FE)
- Config-driven design: behavior controlled entirely by YAML files

##### Technologies & Frameworks to Call Out
- Python 3.x
- Deep-learning library (e.g., TensorFlow or PyTorch—imported within src/models/cnn_model.py)
- Hydra or custom YAML parser (via src/utils/config.py)
- Logging framework (standard library logging via src/utils/logger.py)
- Third-party packages listed in requirements.txt

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Subgraphs and modules
    subgraph "Utilities & Config"
        ConfigFiles["Configuration Files"]:::config
        ConfigManager["Config Parser"]:::util
        Logger["Logger Utility"]:::util
        Metadata["Metadata & Build Scripts"]:::util
    end

    subgraph "Data Processing"
        DataLoader["DataLoader"]:::data
        Preprocessor["Preprocessor"]:::data
        FeatureEngineer["FeatureEngineer"]:::data
    end

    subgraph "Model Definition"
        BaseModel["BaseModel"]:::model
        CNNModel["CNNModel"]:::model
        ModelFactory["ModelFactory"]:::model
    end

    subgraph "Training & Tuning"
        Trainer["Trainer"]:::training
        CrossValidation["CrossValidation"]:::training
        HyperparameterTuning["HyperparameterTuning"]:::training
    end

    subgraph "Evaluation"
        Metrics["Metrics Module"]:::evaluation
        Explainability["Explainability Module"]:::evaluation
        Visualization["Visualization Module"]:::evaluation
    end

    %% External Artifacts
    RawDataStorage["Raw Data Storage"]:::external
    Checkpoints["Model Checkpoints"]:::external
    Reports["Reports & Plots"]:::external

    %% Connections
    RawDataStorage -->|provides data| DataLoader
    ConfigFiles -->|provides settings| ConfigManager
    ConfigManager -->|config| DataLoader
    ConfigManager -->|config| Preprocessor
    ConfigManager -->|config| FeatureEngineer
    ConfigManager -->|config| ModelFactory
    ConfigManager -->|config| Trainer
    ConfigManager -->|config| CrossValidation
    ConfigManager -->|config| HyperparameterTuning
    ConfigManager -->|config| Metrics
    ConfigManager -->|config| Explainability
    ConfigManager -->|config| Visualization

    DataLoader -->|processed| Preprocessor
    Preprocessor -->|features| FeatureEngineer
    FeatureEngineer -->|training data| Trainer

    ModelFactory -->|instantiates| Trainer

    Trainer -->|trains| CrossValidation
    CrossValidation -->|fold results| Trainer
    Trainer -->|trains| HyperparameterTuning
    HyperparameterTuning -->|tuning loop| Trainer

    Trainer -->|model output| Checkpoints
    Trainer -->|model| Metrics
    Trainer -->|model| Explainability
    Trainer -->|model| Visualization

    Metrics -->|outputs| Reports
    Explainability -->|outputs| Reports
    Visualization -->|outputs| Reports

    %% Logging
    DataLoader -->|logs| Logger
    Preprocessor -->|logs| Logger
    FeatureEngineer -->|logs| Logger
    ModelFactory -->|logs| Logger
    Trainer -->|logs| Logger
    CrossValidation -->|logs| Logger
    HyperparameterTuning -->|logs| Logger
    Metrics -->|logs| Logger
    Explainability -->|logs| Logger
    Visualization -->|logs| Logger

    %% Click Events
    click ConfigFiles "https://github.com/mwasifanwar/industrialprognosisai/tree/main/configs/"
    click ConfigManager "https://github.com/mwasifanwar/industrialprognosisai/blob/main/src/utils/config.py"
    click Logger "https://github.com/mwasifanwar/industrialprognosisai/blob/main/src/utils/logger.py"
    click Metadata "https://github.com/mwasifanwar/industrialprognosisai/blob/main/pyproject.toml"
    click DataLoader "https://github.com/mwasifanwar/industrialprognosisai/blob/main/src/data/data_loader.py"
    click Preprocessor "https://github.com/mwasifanwar/industrialprognosisai/blob/main/src/data/preprocessor.py"
    click FeatureEngineer "https://github.com/mwasifanwar/industrialprognosisai/blob/main/src/data/feature_engineer.py"
    click BaseModel "https://github.com/mwasifanwar/industrialprognosisai/blob/main/src/models/base_model.py"
    click CNNModel "https://github.com/mwasifanwar/industrialprognosisai/blob/main/src/models/cnn_model.py"
    click ModelFactory "https://github.com/mwasifanwar/industrialprognosisai/blob/main/src/models/model_factory.py"
    click Trainer "https://github.com/mwasifanwar/industrialprognosisai/blob/main/src/training/trainer.py"
    click CrossValidation "https://github.com/mwasifanwar/industrialprognosisai/blob/main/src/training/cross_validation.py"
    click HyperparameterTuning "https://github.com/mwasifanwar/industrialprognosisai/blob/main/src/training/hyperparameter_tuning.py"
    click Metrics "https://github.com/mwasifanwar/industrialprognosisai/blob/main/src/evaluation/metrics.py"
    click Explainability "https://github.com/mwasifanwar/industrialprognosisai/blob/main/src/evaluation/explainability.py"
    click Visualization "https://github.com/mwasifanwar/industrialprognosisai/blob/main/src/evaluation/visualization.py"

    %% Styles
    classDef data fill:#cfe2f3,stroke:#000,stroke-width:1px;
    classDef model fill:#d9ead3,stroke:#000,stroke-width:1px;
    classDef training fill:#f9cb9c,stroke:#000,stroke-width:1px;
    classDef evaluation fill:#d5a6bd,stroke:#000,stroke-width:1px;
    classDef util fill:#e7e6e6,stroke:#000,stroke-width:1px;
    classDef config fill:#e7e6e6,stroke:#000,stroke-width:1px;
    classDef external fill:#ffffff,stroke:#666,stroke-dasharray: 4 2;
```
