# cfa-institute-rpc/the-automation-ahead architecture

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

- Interactive diagram: https://gitdiagram.com/cfa-institute-rpc/the-automation-ahead
- Repository: https://github.com/cfa-institute-rpc/the-automation-ahead

## Overview

##### Project type and purpose
- This is a monorepo of Python/Jupyter‐based code examples and tutorials illustrating generative AI applications in finance. It’s not a single full‐stack “app” but rather a set of loosely coupled “sub‐projects” (or modules) each demonstrating a workflow:
- Agents (agentic AI workflows and case studies)
- Introduction & Automation Framework (conceptual framework notebook)
- Practical Guide for LLMs (LLM comparison & execution notebooks)
- Retrieval Augmented Generation (RAG pipelines: proxy statements, news updater, visualizations)
- The goal: teach finance professionals how to wire up GenAI tools, data sources, and automation scripts.

##### File structure
- Top‐level
- .github/workflows: CI for daily briefs
- .env.example / .gitignore: environment and VCS config
- README.md, LICENSE
- Four main folders (Agents, Introduction and Automation Framework, Practical Guide For LLMs In the Financial Industry, Retrieval Augmented Generation)
- Modules
- Agents: Python packages + Jupyter case studies + “regime screening” and “sustainability research” workflows as DAG‐style code + a huge “reports” folder containing pre‐generated JSON/CSV outputs per ticker
- Introduction… & Practical Guide…: mostly standalone notebooks + markdown guides
- Retrieval Augmented Generation:
– Community Examples (static)
– Interfacing Proxy Statements: data folder of PDFs + evaluation notebook + ground truth
– Portfolio News Updater: automation_scripts folder with a daily_news_brief.py + RSS config + requirements.txt + env example
– Visualizations: notebooks demonstrating embedding plots + media files

##### README for additional insights
- Project is structured as a learning resource, not a hosted service
- Encourages forking/adapting scripts

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Developer Environment
    subgraph "Developer Environment"
        direction TB
        EnvExample[".env.example"]:::config
        Gitignore[".gitignore"]:::config
    end

    click EnvExample "https://github.com/cfa-institute-rpc/the-automation-ahead/blob/main/.env.example"
    click Gitignore "https://github.com/cfa-institute-rpc/the-automation-ahead/blob/main/.gitignore"

    DevRun["Local Python/Jupyter"]:::code

    DevRun -->|clones Repo| Repo

    %% Repository Modules
    subgraph "Repository Modules"
        direction TB
        subgraph "Agents Module" 
            direction TB
            AgentsRoot["Agents/"]:::code
            subgraph "Regime Screening Workflow"
                direction TB
                RegimeWorkflow["Regime Screening Workflow"]:::code
            end
            subgraph "Sustainability Research Workflow"
                direction TB
                SustainabilityWorkflow["Sustainability Research Workflow"]:::code
            end
            CaseStudyNotebook["Case-Study Notebooks"]:::doc
            GeneratedReports[(Generated Reports)]:::storage
        end

        subgraph "Introduction & Automation Framework"
            direction TB
            IntroModule["Introduction and Automation Framework/"]:::code
        end

        subgraph "Practical Guide for LLMs"
            direction TB
            PracticalGuide["Practical Guide For LLMs In the Financial Industry/"]:::code
        end

        subgraph "RAG Module"
            direction TB
            RAGRoot["Retrieval Augmented Generation/"]:::code

            subgraph "Community Examples"
                direction TB
                CommunityExamples["Community Examples"]:::doc
            end

            subgraph "Interfacing Proxy Statements"
                direction TB
                ProxyStatements["Interfacing Proxy Statements"]:::code
                GroundTruth["Ground Truth Table"]:::storage
            end

            subgraph "Portfolio News Updater"
                direction TB
                AutomationScripts["Automation Scripts"]:::code
                DailyScript["daily_news_brief.py"]:::code
                RSSConfig["news_rss.json"]:::data
                RAGEnv[".env.example"]:::config
                ReqTxt["requirements.txt"]:::config
            end

            subgraph "Visualizations"
                direction TB
                VizNotebook["Embeddings and RAG.ipynb"]:::doc
                Media["media (gifs/images/videos)"]:::storage
            end
        end
    end

    click AgentsRoot "https://github.com/cfa-institute-rpc/the-automation-ahead/tree/main/Agents/"
    click RegimeWorkflow "https://github.com/cfa-institute-rpc/the-automation-ahead/tree/main/Agents/regime_screening_workflow/"
    click SustainabilityWorkflow "https://github.com/cfa-institute-rpc/the-automation-ahead/tree/main/Agents/sustainability_research_workflow/"
    click CaseStudyNotebook "https://github.com/cfa-institute-rpc/the-automation-ahead/blob/main/Agents/Agent-Augmented Portfolio Construction - Case Study.ipynb"
    click GeneratedReports "https://github.com/cfa-institute-rpc/the-automation-ahead/tree/main/Agents/reports/"
    click IntroModule "https://github.com/cfa-institute-rpc/the-automation-ahead/tree/main/Introduction and Automation Framework/"
    click PracticalGuide "https://github.com/cfa-institute-rpc/the-automation-ahead/tree/main/Practical Guide For LLMs In the Financial Industry/"
    click RAGRoot "https://github.com/cfa-institute-rpc/the-automation-ahead/tree/main/Retrieval Augmented Generation/"
    click CommunityExamples "https://github.com/cfa-institute-rpc/the-automation-ahead/tree/main/Retrieval Augmented Generation/Community Examples/"
    click ProxyStatements "https://github.com/cfa-institute-rpc/the-automation-ahead/tree/main/Retrieval Augmented Generation/Interfacing Proxy Statements/"
    click AutomationScripts "https://github.com/cfa-institute-rpc/the-automation-ahead/tree/main/Retrieval Augmented Generation/Portfolio News Updater/automation_scripts/"
    click DailyScript "https://github.com/cfa-institute-rpc/the-automation-ahead/blob/main/Retrieval Augmented Generation/Portfolio News Updater/automation_scripts/daily_news_brief.py"
    click RSSConfig "https://github.com/cfa-institute-rpc/the-automation-ahead/blob/main/Retrieval Augmented Generation/Portfolio News Updater/automation_scripts/news_rss.json"
    click RAGEnv "https://github.com/cfa-institute-rpc/the-automation-ahead/blob/main/Retrieval Augmented Generation/Portfolio News Updater/.env.example"
    click ReqTxt "https://github.com/cfa-institute-rpc/the-automation-ahead/blob/main/Retrieval Augmented Generation/Portfolio News Updater/requirements.txt"
    click VizNotebook "https://github.com/cfa-institute-rpc/the-automation-ahead/blob/main/Retrieval Augmented Generation/Visualizations/Embeddings and RAG.ipynb"
    click Media "https://github.com/cfa-institute-rpc/the-automation-ahead/tree/main/Retrieval Augmented Generation/Visualizations/media/"

    %% External Services and Data Sources
    subgraph "External Services"
        direction TB
        LLMAPI["LLM APIs (OpenAI, Anthropic)"]:::external
        SECEDGAR["SEC EDGAR PDFs"]:::data
        RSSFeeds["RSS Endpoints"]:::data
    end

    %% CI/CD
    subgraph "CI/CD"
        direction TB
        GitHubActions["GitHub Actions"]:::ci
    end
    click GitHubActions "https://github.com/cfa-institute-rpc/the-automation-ahead/blob/main/.github/workflows/daily_brief.yml"

    %% Vector Store & Processing
    DataIngest["Data Ingestion"]:::process
    VectorStore[(Vector Store)]:::storage
    Retrieval["Retrieval + Prompting"]:::process
    Insights["Generated Insights"]:::doc

    %% Flows
    SECEDGAR -->|provides PDFs| DataIngest
    RSSFeeds -->|provides feeds| DataIngest
    DataIngest -->|embeddings| VectorStore
    VectorStore -->|retrieval| Retrieval
    Retrieval -->|calls API| LLMAPI
    LLMAPI -->|insights| Insights
    Insights --> VizNotebook

    %% Agents Workflows
    RegimeWorkflow --> GeneratedReports
    SustainabilityWorkflow --> GeneratedReports

    %% Developer runs notebooks/scripts
    DevRun --> RegimeWorkflow
    DevRun --> SustainabilityWorkflow
    DevRun --> IntroModule
    DevRun --> PracticalGuide
    DevRun --> RAGRoot

    %% CI triggers daily script
    GitHubActions -.->|schedules| DailyScript
    DailyScript -->|generates| Insights

    %% Styles
    classDef code fill:#e0f7fa,stroke:#006064,color:#004d40
    classDef doc fill:#e8f5e9,stroke:#2e7d32,color:#1b5e20
    classDef storage fill:#fff3e0,stroke:#ef6c00,color:#e65100
    classDef data fill:#f1f8e9,stroke:#33691e,color:#1b5e20
    classDef external fill:#ffebee,stroke:#c62828,color:#b71c1c,stroke-width:2px
    classDef process fill:#e3f2fd,stroke:#1565c0,color:#0d47a1
    classDef ci fill:#eeeeee,stroke:#757575,color:#424242
    classDef config fill:#f3e5f5,stroke:#6a1b9a,color:#4a148c
```
