shubham-kumr/project_carbon

Project_c12 : Carbon-Aware Model Router Interface

1

stars

2

commits

Python

primary language

Jun 17, 2025

updated

README

🌱 Project-C12: Carbon-Aware Model Router

Project-C12 is an intelligent system that helps select the most carbon-efficient AI models based on real-time carbon intensity data. It provides a dashboard for monitoring and optimizing model selection to minimize carbon emissions.

πŸ“š Read our detailed introduction | πŸ—ΊοΈ View the project roadmap

✨ Features

  • πŸ”„ Real-time carbon intensity monitoring
  • πŸ€– Smart model selection (TinyLlama, CodeLlama, GPT-2)
  • πŸ“Š Performance metrics visualization
  • πŸ’‘ Optimization recommendations
  • 🌍 Carbon footprint tracking
  • πŸ’» Code-aware query routing

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/project-c12.git
cd project-c12
  1. Install dependencies:
pip install -r requirements.txt
pip install -r requirements-dashboard.txt
  1. Run the dashboard:
streamlit run src/dashboard/app.py

πŸ“ Project Structure

project-c12/
β”œβ”€β”€ data/
β”‚   └── metrics.db         # Centralized metrics database
β”œβ”€β”€ docs/
β”‚   β”œβ”€β”€ README.md         # Documentation index
β”‚   β”œβ”€β”€ INTRODUCTION.md   # Detailed project overview
β”‚   └── MASTERPLAN.md     # Project roadmap
β”œβ”€β”€ monitoring/
β”‚   └── prometheus.yml    # Prometheus configuration
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ api/             # FastAPI backend
β”‚   β”‚   β”œβ”€β”€ main.py      # API endpoints
β”‚   β”‚   β”œβ”€β”€ models/      # AI model files
β”‚   β”‚   β”œβ”€β”€ routes/      # API route handlers
β”‚   β”‚   β”œβ”€β”€ schemas/     # Data models
β”‚   β”‚   └── services/    # Core services
β”‚   └── dashboard/       # Streamlit frontend
β”‚       β”œβ”€β”€ app.py       # Dashboard UI
β”‚       └── data/        # Symlinked to /data
β”œβ”€β”€ tests/               # Test suite
β”œβ”€β”€ Dockerfile.api       # API service Dockerfile
β”œβ”€β”€ Dockerfile.dashboard # Dashboard service Dockerfile
β”œβ”€β”€ docker-compose.yml   # Service orchestration
β”œβ”€β”€ requirements.txt     # API dependencies
└── README.md           # This file

🐳 Docker Deployment

The project includes a complete Docker setup for all services:

# Build and start all services
docker-compose up -d

# View logs
docker-compose logs -f

# Stop all services
docker-compose down

Services will be available at:

🀝 Contributing

Contributions are welcome! Please read our detailed introduction to understand the project better.

πŸ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributors

shubham-kumr

2 commits

shubham-kumr/project_carbon

Project_c12 : Carbon-Aware Model Router Interface

1

stars

2

commits

Python

primary language

Jun 17, 2025

updated

README

🌱 Project-C12: Carbon-Aware Model Router

Project-C12 is an intelligent system that helps select the most carbon-efficient AI models based on real-time carbon intensity data. It provides a dashboard for monitoring and optimizing model selection to minimize carbon emissions.

πŸ“š Read our detailed introduction | πŸ—ΊοΈ View the project roadmap

✨ Features

  • πŸ”„ Real-time carbon intensity monitoring
  • πŸ€– Smart model selection (TinyLlama, CodeLlama, GPT-2)
  • πŸ“Š Performance metrics visualization
  • πŸ’‘ Optimization recommendations
  • 🌍 Carbon footprint tracking
  • πŸ’» Code-aware query routing

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/project-c12.git
cd project-c12
  1. Install dependencies:
pip install -r requirements.txt
pip install -r requirements-dashboard.txt
  1. Run the dashboard:
streamlit run src/dashboard/app.py

πŸ“ Project Structure

project-c12/
β”œβ”€β”€ data/
β”‚   └── metrics.db         # Centralized metrics database
β”œβ”€β”€ docs/
β”‚   β”œβ”€β”€ README.md         # Documentation index
β”‚   β”œβ”€β”€ INTRODUCTION.md   # Detailed project overview
β”‚   └── MASTERPLAN.md     # Project roadmap
β”œβ”€β”€ monitoring/
β”‚   └── prometheus.yml    # Prometheus configuration
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ api/             # FastAPI backend
β”‚   β”‚   β”œβ”€β”€ main.py      # API endpoints
β”‚   β”‚   β”œβ”€β”€ models/      # AI model files
β”‚   β”‚   β”œβ”€β”€ routes/      # API route handlers
β”‚   β”‚   β”œβ”€β”€ schemas/     # Data models
β”‚   β”‚   └── services/    # Core services
β”‚   └── dashboard/       # Streamlit frontend
β”‚       β”œβ”€β”€ app.py       # Dashboard UI
β”‚       └── data/        # Symlinked to /data
β”œβ”€β”€ tests/               # Test suite
β”œβ”€β”€ Dockerfile.api       # API service Dockerfile
β”œβ”€β”€ Dockerfile.dashboard # Dashboard service Dockerfile
β”œβ”€β”€ docker-compose.yml   # Service orchestration
β”œβ”€β”€ requirements.txt     # API dependencies
└── README.md           # This file

🐳 Docker Deployment

The project includes a complete Docker setup for all services:

# Build and start all services
docker-compose up -d

# View logs
docker-compose logs -f

# Stop all services
docker-compose down

Services will be available at:

🀝 Contributing

Contributions are welcome! Please read our detailed introduction to understand the project better.

πŸ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributors

shubham-kumr

2 commits

Languages

Python

100.0%