# apress/statistical-quantitative-methods-in-finance architecture

> Architecture diagram of the GitHub repository apress/statistical-quantitative-methods-in-finance, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/apress/statistical-quantitative-methods-in-finance
- Repository: https://github.com/apress/statistical-quantitative-methods-in-finance

## Overview

##### Project type and purpose
- This is an open-source code repository accompanying a finance-focused quantitative methods book. It provides a suite of Python scripts and modules implementing statistical models (GLMs, factor models, mixture models, regression trees, clustering, text embeddings, MCMC, etc.) along with sample data.

##### File structure
- Top-level Python files each implement a specific model or algorithm (e.g., BinomialGLM.py, RandomForest.py, KMeans.py, Word2Vec.py).
- A “data/” directory contains CSV inputs used by those scripts.
- There are no separate “frontend” or “backend” folders—this is a library/toolkit.
- Utility modules (e.g., GramSchmidt.py, HouseHolder.py) provide shared linear-algebra routines.
- Contributing.md and LICENSE.txt govern collaboration and licensing.

##### README for additional insights
- The README confirms that this repository is a direct code supplement for a book on statistical quantitative methods in finance.

##### Detail
- Utility dependencies (GramSchmidt → GaussianMixtureModel).
- That “combinedFiles.py” may import and run multiple model modules in sequence.
- If desired, annotate approximate data sizes or execution order.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Data Layer
    DataLayer[(Data Layer)]:::data

    %% Preprocessing / Utilities
    subgraph "Preprocessing / Utilities"
        GramSchmidt["GramSchmidt.py"]:::util
        HouseHolder["HouseHolder.py"]:::util
    end

    %% Modeling Components
    subgraph "Model Modules"
        subgraph "Regression Models"
            Binomial["BinomialGLM.py"]:::model
            Gamma["GammaGLM.py"]:::model
            Poisson["poissonGLM.py"]:::model
            Normal["normalGLM.py"]:::model
            Multinomial["MultinomialGLM.py"]:::model
        end
        subgraph "Factor Models"
            FF5["FF5Model.py"]:::model
            Phillips["PhillipsCurve.py"]:::model
            Taylor["TaylorRule.py"]:::model
            TaylorTVTP["TaylorRuleTVTP.py"]:::model
        end
        subgraph "Limited Dependent Models"
            Tobit["TobitModel.py"]:::model
            Tobit1["Tobit1Model.py"]:::model
            Heckman["Heckman2StepModel.py"]:::model
            Censored["CensoredData.py"]:::model
        end
        subgraph "Tree & Ensemble Methods"
            RF["RandomForest.py"]:::model
            RFReg["RFRegression.py"]:::model
            RFClass["RFClassificationBankProduct.py"]:::model
            RFChoice["RFChoice.py"]:::model
        end
        subgraph "Clustering & Unsupervised"
            KMeans["KMeans.py"]:::model
            Kernel["KernelRegression.py"]:::model
        end
        subgraph "Optimization & MCMC"
            MH["MetropolisHastings.py"]:::model
        end
        subgraph "Text Embedding"
            Glove["Glove.py"]:::model
            Word2Vec["Word2Vec.py"]:::model
        end
    end

    %% Orchestrator Scripts
    subgraph "Orchestrator Scripts"
        Predict[/PredictAssetReturns.py/]:::orchestrator
        Combined[/combinedFiles.py/]:::orchestrator
    end

    %% Data Flow
    DataLayer --> GramSchmidt
    DataLayer --> HouseHolder
    GramSchmidt -.->|uses| Binomial
    GramSchmidt -.->|uses| FF5
    HouseHolder -.->|uses| Gamma
    GramSchmidt -.->|uses| MH
    DataLayer --> Combined
    Combined -->|invokes| Binomial
    Combined -->|invokes| Gamma
    Combined -->|invokes| RF
    Predict -->|runs pipeline| Combined

    %% Classes
    classDef data fill:#bbdefb,stroke:#0d47a1,color:#0d47a1
    classDef util fill:#c8e6c9,stroke:#1b5e20,color:#1b5e20
    classDef model fill:#ffe0b2,stroke:#e65100,color:#e65100
    classDef orchestrator fill:#e1bee7,stroke:#4a148c,color:#4a148c

    %% Click Events
    click DataLayer "https://github.com/apress/statistical-quantitative-methods-in-finance/tree/main/data/"
    click GramSchmidt "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/GramSchmidt.py"
    click HouseHolder "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/HouseHolder.py"
    click Binomial "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/BinomialGLM.py"
    click Gamma "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/GammaGLM.py"
    click Poisson "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/poissonGLM.py"
    click Normal "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/normalGLM.py"
    click Multinomial "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/MultinomialGLM.py"
    click FF5 "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/FF5Model.py"
    click Phillips "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/PhillipsCurve.py"
    click Taylor "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/TaylorRule.py"
    click TaylorTVTP "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/TaylorRuleTVTP.py"
    click Tobit "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/TobitModel.py"
    click Tobit1 "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/Tobit1Model.py"
    click Heckman "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/Heckman2StepModel.py"
    click Censored "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/CensoredData.py"
    click RF "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/RandomForest.py"
    click RFReg "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/RFRegression.py"
    click RFClass "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/RFClassificationBankProduct.py"
    click RFChoice "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/RFChoice.py"
    click KMeans "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/KMeans.py"
    click Kernel "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/KernelRegression.py"
    click MH "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/MetropolisHastings.py"
    click Glove "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/Glove.py"
    click Word2Vec "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/Word2Vec.py"
    click Predict "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/PredictAssetReturns.py"
    click Combined "https://github.com/apress/statistical-quantitative-methods-in-finance/blob/main/combinedFiles.py"
```
