# oracle/accelerated-data-science architecture

> Architecture diagram of the GitHub repository oracle/accelerated-data-science, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/oracle/accelerated-data-science
- Repository: https://github.com/oracle/accelerated-data-science

## Overview

##### Main Components

a. Core SDK Layer:
- Core modules: common, model, dataset, feature_engineering
- Connection to OCI authentication and configuration

b. Service Integration Layer:
- OCI services that ADS interfaces with:
- Data Science service
- Model Catalog
- Model Deployment
- Jobs
- ML Pipelines
- Data Flow
- Object Storage
- Vault
- Big Data Service
- Data Catalog
- Autonomous Database

c. Feature Modules Layer:
- Functional modules:
- Data Loading (database, oracledb, mysqldb)
- Model Management (model, deployment)
- Feature Engineering (feature_engineering, type_discovery)
- ML Operations (jobs, pipeline)
- Evaluation & Tuning (evaluations, hpo)
- LLM Integration (llm, aqua)

d. Extensions and Tools Layer:
- CLI tools (opctl)
- Operators (forecast, anomaly, etc.)
- Visualization components

##### Relationships and Data Flow

- Authentication flow from applications through the SDK to OCI services
- Data flow between components
- Model lifecycle flow
- Job execution flow

##### Implementation Details

- Component Name     |

- Key Features         |
- Supported Formats    |
- Integration Points   |

**[Client Applications/Notebooks]**
- ↓
**[ADS Core (Authentication/Configuration)]**
- ↓
**[Feature Modules] ↔ [OCI Services]**
- ↓
**[Extensions/Tools/CLI]**

##### Technical Details to Highlight

- How the SDK handles different authentication methods
- Model lifecycle management
- Demonstrate the job execution flow
- Data ingestion patterns
- Integration points with ML frameworks

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and Classes
    classDef core fill:#3498db,stroke:#2980b9,color:white
    classDef service fill:#e67e22,stroke:#d35400,color:white
    classDef feature fill:#2ecc71,stroke:#27ae60,color:white
    classDef extension fill:#9b59b6,stroke:#8e44ad,color:white
    classDef client fill:#95a5a6,stroke:#7f8c8d,color:white

    %% Client Layer
    Client["Client Applications/Notebooks"]:::client

    %% Core SDK Layer
    subgraph CoreSDK["Core SDK Layer"]
        Common["Common Module"]:::core
        ModelCore["Model Core"]:::core
        DatasetCore["Dataset Core"]:::core
        FeatureCore["Feature Engineering Core"]:::core
        Auth["Authentication/Configuration"]:::core
    end

    %% Service Integration Layer
    subgraph Services["Service Integration Layer"]
        DS["Data Science Service"]:::service
        MC["Model Catalog"]:::service
        MD["Model Deployment"]:::service
        Jobs["Jobs Service"]:::service
        MLP["ML Pipelines"]:::service
        DF["Data Flow"]:::service
        OS["Object Storage"]:::service
        Vault["Vault"]:::service
        BDS["Big Data Service"]:::service
        DC["Data Catalog"]:::service
        ADB["Autonomous Database"]:::service
    end

    %% Feature Modules Layer
    subgraph Features["Feature Modules Layer"]
        DataLoad["Data Loading"]:::feature
        ModelMgmt["Model Management"]:::feature
        FeatEng["Feature Engineering"]:::feature
        MLOps["ML Operations"]:::feature
        EvalTune["Evaluation & Tuning"]:::feature
        LLM["LLM Integration"]:::feature
    end

    %% Extensions Layer
    subgraph Extensions["Extensions and Tools Layer"]
        CLI["CLI Tools"]:::extension
        Operators["Operators"]:::extension
        Viz["Visualization"]:::extension
    end

    %% Relationships
    Client --> Auth
    Auth --> Common
    Common --> Services
    Common --> Features
    Features --> Services
    Features --> Extensions

    %% Click Events
    click Common "https://github.com/oracle/accelerated-data-science/tree/main/ads/common/"
    click ModelCore "https://github.com/oracle/accelerated-data-science/tree/main/ads/model/"
    click DatasetCore "https://github.com/oracle/accelerated-data-science/tree/main/ads/dataset/"
    click FeatureCore "https://github.com/oracle/accelerated-data-science/tree/main/ads/feature_engineering/"
    click DS "https://github.com/oracle/accelerated-data-science/blob/main/ads/common/oci_datascience.py"
    click MC "https://github.com/oracle/accelerated-data-science/tree/main/ads/catalog/"
    click MD "https://github.com/oracle/accelerated-data-science/tree/main/ads/model/deployment/"
    click Jobs "https://github.com/oracle/accelerated-data-science/tree/main/ads/jobs/"
    click MLP "https://github.com/oracle/accelerated-data-science/tree/main/ads/pipeline/"
    click DF "https://github.com/oracle/accelerated-data-science/blob/main/ads/opctl/backend/ads_dataflow.py"
    click Vault "https://github.com/oracle/accelerated-data-science/tree/main/ads/vault/"
    click BDS "https://github.com/oracle/accelerated-data-science/tree/main/ads/bds/"
    click DataLoad "https://github.com/oracle/accelerated-data-science/tree/main/ads/database/"
    click ModelMgmt "https://github.com/oracle/accelerated-data-science/tree/main/ads/model/service/"
    click FeatEng "https://github.com/oracle/accelerated-data-science/tree/main/ads/feature_engineering/"
    click MLOps "https://github.com/oracle/accelerated-data-science/tree/main/ads/jobs/"
    click EvalTune "https://github.com/oracle/accelerated-data-science/tree/main/ads/evaluations/"
    click LLM "https://github.com/oracle/accelerated-data-science/tree/main/ads/llm/"
    click CLI "https://github.com/oracle/accelerated-data-science/blob/main/ads/cli.py"
    click Operators "https://github.com/oracle/accelerated-data-science/tree/main/ads/opctl/operator/"
    click Viz "https://github.com/oracle/accelerated-data-science/blob/main/ads/dataset/plot.py"

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["OCI Services"]:::service
        L3["Feature Modules"]:::feature
        L4["Extensions & Tools"]:::extension
        L5["Client Layer"]:::client
    end
```
