Skip to content

A React + Node.js application that tracks and visualizes the energy consumption and carbon footprint of machine learning training runs in real time. The dashboard integrates with MongoDB for data storage and streams updates using WebSockets.

License

Notifications You must be signed in to change notification settings

The-Purple-Movement/AI-Model-Efficiency-Dashboard-

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 

Repository files navigation

AI Model Efficiency Dashboard

A modern React + Node.js web app that tracks & visualizes the energy consumption and carbon footprint of machine learning training runs in real‑time.

React
Node.js
MongoDB
WebSockets
License: GPL‑v3


Table of Contents


🚀 Overview

Machine‑learning models are becoming ever more powerful—and energy‑hungry. AI Model Efficiency Dashboard gives data scientists, MLOps engineers, and sustainability officers a single pane of glass to:

  • Monitor energy usage & carbon emissions in real time as training runs progress.
  • Store every run’s metrics in a persistent MongoDB database.
  • Visualize trends with interactive charts, heat‑maps, and KPI widgets.
  • React instantly to anomalies via WebSocket‑powered live updates.

Note: This repository currently holds the concept & design for the dashboard. Development is open‑source and we welcome contributors to bring the idea to life!


✨ Features

Feature
🌱 Real‑time energy & carbon tracking – Stream per‑step consumption data via WebSockets.
📊 Dynamic visualizations – Line charts, bar graphs, and gauge widgets powered by Chart.js / D3.
🗄️ MongoDB persistence – Every training run is archived for historical analysis.
👤 User authentication & role‑based access – Secure view for admins, engineers, and auditors.
⚙️ Configurable thresholds & alerts – Get notified when a run exceeds a carbon budget.
📱 Responsive UI – Works on desktop, tablet, and mobile browsers.
📦 Modular architecture – Front‑end (React) & back‑end (Node/Express) are decoupled for easy scaling.

(Add more features as the project evolves!)


🛠️ Installation

⚠️ There are currently no runnable code artifacts.
This repository is a project blueprint. When the first implementation is ready, the installation steps will be added here.

If you’d like to start building the dashboard now, you can clone the repo and set up a typical React + Node environment:

git clone https://github.com/your-username/ai-model-efficiency-dashboard.git
cd ai-model-efficiency-dashboard
# Front‑end
cd client && npm install && npm start
# Back‑end
cd ../server && npm install && npm run dev

Replace the placeholder commands with the actual scripts once they exist.


💡 Usage

No usable application is available yet.

When the dashboard is live, typical usage will look like:

  1. Connect your ML training pipeline to the WebSocket endpoint (ws://<server>/run-stream).
  2. Push JSON payloads containing timestamp, energy_kWh, co2_kg, and any custom metrics.
  3. Open the web UI (http://localhost:3000) and watch the live charts update.
  4. Explore historical runs via the “Archives” tab, filter by model, dataset, or date range.

More detailed usage docs will be added after the first MVP release.


🤝 Contributing

We love community contributions! Follow these steps to get started:

  1. Fork the repository.

  2. Create a branch for your feature or bug‑fix:

    git checkout -b feat/awesome-feature
  3. Write clean, documented code and adhere to the existing folder structure (client/ for React, server/ for Node).

  4. Add tests where applicable (Jest for front‑end, Mocha/Chai for back‑end).

  5. Run the linter (npm run lint) and ensure all tests pass.

  6. Commit with a clear message and push to your fork.

  7. Open a Pull Request against the main branch, describing the change and linking any relevant issue.

Code of Conduct

Please read our CODE_OF_CONDUCT.md (to be added) and follow the community guidelines.

Development Checklist

  • Set up local MongoDB instance (or use Atlas).
  • Implement WebSocket server (socket.io or native WS).
  • Create React UI skeleton with routing (react-router).
  • Add chart components (Chart.js, Recharts, or D3).
  • Write unit & integration tests.

Feel free to open an issue to discuss ideas before diving in!


📜 License

This project is licensed under the GNU General Public License v3.0. See the full license text in the LICENSE file.

Copyright (C) 2025 THE PURPLE MOVEMENT

📞 Contact

The Purple Movement

If you have questions, suggestions, or just want to say hi, drop us a line!


📸 Screenshots / Mockups

Placeholder images – replace with real screenshots once the UI is built.

Overview Real‑time Chart Settings
Dashboard Overview Live Chart Settings

Repository

https://github.com/The-Purple-Movement/ai-model-efficiency-dashboard

Live Demo

Coming soon – stay tuned!


Happy coding! 🚀

About

A React + Node.js application that tracks and visualizes the energy consumption and carbon footprint of machine learning training runs in real time. The dashboard integrates with MongoDB for data storage and streams updates using WebSockets.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published