# guymizrahi1/nitrogen-status-by-spectroscopy architecture

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

- Interactive diagram: https://gitdiagram.com/guymizrahi1/nitrogen-status-by-spectroscopy
- Repository: https://github.com/guymizrahi1/nitrogen-status-by-spectroscopy

## Overview

##### Project Type Analysis
This is a machine learning project with multiple model implementations (RF, XGBoost, PLSR) for spectroscopy-based nitrogen status identification. The structure suggests a data processing pipeline with various modeling approaches.

##### Main Components

A. Data Layer:
- Raw Data Storage (datasets directory)
- Training data (train_data.parquet, train_data_plsr.parquet)
- Validation data (validation_data.parquet, validation_data_plsr.parquet)
- Test data (test_data.parquet, test_data_plsr.parquet)

B. Data Preparation Layer:
- Data preprocessing (data_preparation.py)
- Configuration settings (constants_config.py)
- Dataset handling (baseline_for_training/Dataset.py)

C. Model Layer:
Three main modeling approaches:
##### PLSR (Partial Least Squares Regression)
- Implementation (PLSR/PLSR.py, PLSR/PLSR_class.py)
- Model storage (PLSR/models)

##### Random Forest
- Implementation (RF/RF.py, RF/rf_main.py)
- Model storage (RF/models)

##### XGBoost
- Implementation (XGBoost/xgboost_multioutput_implement.py)
- Utilities (XGBoost/utils.py)
- Model storage (XGBoost/models)

D. Evaluation & Output Layer:
- Model outputs (PLSR/outputs)
- Performance metrics storage
- Visualization components (PLSR/Plots, RF/plots, XGBoost/figures)

##### Specific Visualization Elements

a. Use rectangles for:
- Data storage components
- Processing modules
- Model implementations

b. Use diamonds for:
- Decision points
- Validation checkpoints
- Model selection points

- Database/Storage components
- Model persistence

- Data flow direction
- Process sequence
- Model training flow
- Evaluation feedback

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Data_Layer
        RawData["Raw Data Storage"]:::data
        TrainData["Training Data"]:::data
        ValData["Validation Data"]:::data
        TestData["Test Data"]:::data
        RawData --> TrainData & ValData & TestData
    end

    subgraph Preparation_Layer
        DataPrep["Data Preprocessing"]:::process
        Config["Configuration Settings"]:::config
        Dataset["Dataset Handler"]:::process
        Training["Training and Tuning"]:::process
        
        Config --> DataPrep
        DataPrep --> Dataset
        Dataset --> Training
    end

    subgraph Model_Layer
        subgraph PLSR_Component
            PLSR_Impl["PLSR Implementation"]:::model
            PLSR_Class["PLSR Class"]:::model
            PLSR_Data["PLSR Data Creation"]:::process
            PLSR_Store[(PLSR Model Storage)]:::storage
        end

        subgraph RF_Component
            RF_Impl["RF Implementation"]:::model
            RF_Main["RF Main"]:::model
            RF_Store[(RF Model Storage)]:::storage
        end

        subgraph XGBoost_Component
            XGB_Impl["XGBoost Implementation"]:::model
            XGB_Utils["XGBoost Utils"]:::process
            XGB_Store[(XGBoost Model Storage)]:::storage
            XGB_Run["XGBoost Runner"]:::process
        end
    end

    subgraph Evaluation_Layer
        PLSR_Out["PLSR Outputs"]:::output
        PLSR_Vis["PLSR Visualization"]:::output
        RF_Vis["RF Visualization"]:::output
        XGB_Vis["XGBoost Visualization"]:::output
        TestScores["Test Scores"]:::output
        FinalReport["Final Report"]:::output
    end

    %% Data Flow
    Data_Layer --> Preparation_Layer
    Preparation_Layer --> Model_Layer
    Model_Layer --> Evaluation_Layer

    %% Model-specific flows
    PLSR_Impl --> PLSR_Store
    PLSR_Class --> PLSR_Store
    PLSR_Store --> PLSR_Out
    PLSR_Out --> PLSR_Vis

    RF_Impl --> RF_Store
    RF_Main --> RF_Store
    RF_Store --> RF_Vis

    XGB_Impl --> XGB_Store
    XGB_Utils --> XGB_Impl
    XGB_Run --> XGB_Impl
    XGB_Store --> XGB_Vis
    XGB_Vis --> TestScores

    PLSR_Vis & RF_Vis & TestScores --> FinalReport

    %% Styling
    classDef data fill:#b3e0ff,stroke:#333,stroke-width:2px
    classDef process fill:#98FB98,stroke:#333,stroke-width:2px
    classDef config fill:#FFE4B5,stroke:#333,stroke-width:2px
    classDef model fill:#FFB6C1,stroke:#333,stroke-width:2px
    classDef storage fill:#DDA0DD,stroke:#333,stroke-width:2px
    classDef output fill:#F0E68C,stroke:#333,stroke-width:2px

    %% Click events
    click RawData "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/tree/main/datasets"
    click TrainData "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/datasets/train_data.parquet"
    click ValData "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/datasets/validation_data.parquet"
    click TestData "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/datasets/test_data.parquet"
    click DataPrep "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/data_preparation.py"
    click Config "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/constants_config.py"
    click Dataset "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/baseline_for_training/Dataset.py"
    click Training "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/baseline_for_training/Training_and_Tuning.py"
    click PLSR_Impl "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/PLSR/PLSR.py"
    click PLSR_Class "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/PLSR/PLSR_class.py"
    click PLSR_Data "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/PLSR/create_plsr_dataframe.py"
    click PLSR_Store "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/PLSR/models/multi_plsr.pkl"
    click RF_Impl "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/RF/RF.py"
    click RF_Main "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/RF/rf_main.py"
    click RF_Store "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/RF/models/rf_model.pkl"
    click XGB_Impl "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/XGBoost/xgboost_multioutput_implement.py"
    click XGB_Utils "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/XGBoost/utils.py"
    click XGB_Store "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/XGBoost/models/xgboost_multi_output/model.pkl"
    click XGB_Run "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/XGBoost/run.py"
    click PLSR_Out "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/tree/main/PLSR/outputs"
    click PLSR_Vis "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/tree/main/PLSR/Plots"
    click RF_Vis "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/tree/main/RF/plots"
    click XGB_Vis "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/tree/main/XGBoost/figures"
    click TestScores "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/XGBoost/figures/test_scores.json"
    click FinalReport "https://github.com/GuyMizrahi1/Nitrogen-Status-By-Spectroscopy/blob/main/final_report/final_report.docx"
```
