Update README.md
Browse files
README.md
CHANGED
|
@@ -8,64 +8,63 @@ colorTo: gray
|
|
| 8 |
pinned: true
|
| 9 |
short_description: 'ROCm-Sentinel, a system designed to redefine how developers '
|
| 10 |
---
|
| 11 |
-
|
| 12 |
<div align="center">
|
| 13 |
<img src="https://img.shields.io/badge/AMD-ROCm-ed1c24?style=for-the-badge&logo=amd&logoColor=white" alt="AMD ROCm" />
|
| 14 |
<img src="https://img.shields.io/badge/AI_Agent-LangGraph-000000?style=for-the-badge&logo=openai&logoColor=white" alt="LangGraph" />
|
| 15 |
<img src="https://img.shields.io/badge/UI-Gradio-ff7c00?style=for-the-badge" alt="Gradio" />
|
| 16 |
|
| 17 |
<h1>🚀 ROCm-Sentinel</h1>
|
| 18 |
-
<p><strong>
|
| 19 |
</div>
|
| 20 |
|
| 21 |
---
|
| 22 |
|
| 23 |
-
## 📖
|
| 24 |
|
| 25 |
-
**ROCm-Sentinel**
|
| 26 |
|
| 27 |
-
|
| 28 |
|
| 29 |
---
|
| 30 |
|
| 31 |
-
## 🎯
|
| 32 |
|
| 33 |
-
1. **
|
| 34 |
-
2. **
|
| 35 |
-
3. **
|
| 36 |
|
| 37 |
---
|
| 38 |
|
| 39 |
-
## 🧠
|
| 40 |
|
| 41 |
-
|
| 42 |
|
| 43 |
-
* 🟢 **
|
| 44 |
-
*
|
| 45 |
-
* ⭐ **
|
| 46 |
-
*
|
| 47 |
|
| 48 |
---
|
| 49 |
|
| 50 |
-
## 🛠️
|
| 51 |
|
| 52 |
-
* **Python 3** -
|
| 53 |
-
* **Gradio** -
|
| 54 |
-
* **LangGraph & LangChain** -
|
| 55 |
-
* **Fireworks AI** -
|
| 56 |
|
| 57 |
---
|
| 58 |
|
| 59 |
-
## ⚙️
|
| 60 |
|
| 61 |
-
|
| 62 |
|
| 63 |
-
1. **
|
| 64 |
```bash
|
| 65 |
git clone [https://github.com/MrZRo/ROCm-Sentinel.git](https://github.com/MrZRo/ROCm-Sentinel.git)
|
| 66 |
cd ROCm-Sentinel
|
| 67 |
|
| 68 |
-
2. **
|
| 69 |
```bash
|
| 70 |
# En Windows
|
| 71 |
python -m venv env
|
|
@@ -76,7 +75,22 @@ Sigue estos pasos para desplegar ROCm-Sentinel en tu propia máquina:
|
|
| 76 |
source env/bin/activate
|
| 77 |
```
|
| 78 |
|
| 79 |
-
3. **
|
| 80 |
```bash
|
| 81 |
pip install -r requirements.txt
|
| 82 |
-
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 8 |
pinned: true
|
| 9 |
short_description: 'ROCm-Sentinel, a system designed to redefine how developers '
|
| 10 |
---
|
|
|
|
| 11 |
<div align="center">
|
| 12 |
<img src="https://img.shields.io/badge/AMD-ROCm-ed1c24?style=for-the-badge&logo=amd&logoColor=white" alt="AMD ROCm" />
|
| 13 |
<img src="https://img.shields.io/badge/AI_Agent-LangGraph-000000?style=for-the-badge&logo=openai&logoColor=white" alt="LangGraph" />
|
| 14 |
<img src="https://img.shields.io/badge/UI-Gradio-ff7c00?style=for-the-badge" alt="Gradio" />
|
| 15 |
|
| 16 |
<h1>🚀 ROCm-Sentinel</h1>
|
| 17 |
+
<p><strong>Secure AI Agent for Automated Migration from NVIDIA CUDA to AMD ROCm (HIP)</strong></p>
|
| 18 |
</div>
|
| 19 |
|
| 20 |
---
|
| 21 |
|
| 22 |
+
## 📖 About the Project
|
| 23 |
|
| 24 |
+
**ROCm-Sentinel** is an AI-assisted tool designed to break vendor lock-in in hardware-accelerated software development. Using an Agentic Workflow, the application takes native NVIDIA CUDA code and automatically translates it to AMD HIP (Heterogeneous-Compute Interface for Portability), ensuring a smooth transition into the AMD ROCm ecosystem.
|
| 25 |
|
| 26 |
+
It acts as more than just a syntactic translator; it incorporates an autonomous **Security Auditor** that reviews the generated code for memory leaks, parallelism issues, and architecture-specific optimizations for AMD.
|
| 27 |
|
| 28 |
---
|
| 29 |
|
| 30 |
+
## 🎯 Goals and Vision
|
| 31 |
|
| 32 |
+
1. **Democratize Hardware:** Facilitate developers and companies in migrating their workloads from closed ecosystems to open and competitive platforms like AMD.
|
| 33 |
+
2. **Secure Migration (Zero-Leak):** Go beyond simple "find and replace". Ensure the resulting code correctly manages unified memory and threads on AMD GPUs.
|
| 34 |
+
3. **Interactive Workflow:** Provide a user-friendly interface where the developer acts as a supervisor (Human-in-the-Loop), guiding the agent through real-time chat.
|
| 35 |
|
| 36 |
---
|
| 37 |
|
| 38 |
+
## 🧠 Language Models (AI Agents)
|
| 39 |
|
| 40 |
+
Our multi-agent architecture (Translator + Auditor) is powered by state-of-the-art LLMs via the Fireworks AI API.
|
| 41 |
|
| 42 |
+
* 🟢 **Current Model in Use: `DeepSeek V3.1`**
|
| 43 |
+
* The project is currently configured to run on DeepSeek V3.1, a highly capable model with exceptional logical reasoning and lightning-fast response times for interactive demonstration.
|
| 44 |
+
* ⭐ **Recommended Model: `Qwen2.5-Coder 32B Instruct`**
|
| 45 |
+
* For production environments and complex code repositories, we **strongly recommend** switching the configuration to the Qwen 2.5 Coder model. Being trained specifically on deep programming syntax, it offers superior fidelity when translating pointers and complex C++/CUDA directives.
|
| 46 |
|
| 47 |
---
|
| 48 |
|
| 49 |
+
## 🛠️ Technologies Used
|
| 50 |
|
| 51 |
+
* **Python 3** - Base language.
|
| 52 |
+
* **Gradio** - Interactive web interface construction.
|
| 53 |
+
* **LangGraph & LangChain** - Agent workflow orchestration (nodes and edges).
|
| 54 |
+
* **Fireworks AI** - Serverless inference provider for open-source LLM models.
|
| 55 |
|
| 56 |
---
|
| 57 |
|
| 58 |
+
## ⚙️ Local Installation and Usage
|
| 59 |
|
| 60 |
+
Follow these steps to deploy ROCm-Sentinel on your local machine:
|
| 61 |
|
| 62 |
+
1. **Clone the repository:**
|
| 63 |
```bash
|
| 64 |
git clone [https://github.com/MrZRo/ROCm-Sentinel.git](https://github.com/MrZRo/ROCm-Sentinel.git)
|
| 65 |
cd ROCm-Sentinel
|
| 66 |
|
| 67 |
+
2. **Create and activate a virtual environment:**
|
| 68 |
```bash
|
| 69 |
# En Windows
|
| 70 |
python -m venv env
|
|
|
|
| 75 |
source env/bin/activate
|
| 76 |
```
|
| 77 |
|
| 78 |
+
3. **Install dependencies:**
|
| 79 |
```bash
|
| 80 |
pip install -r requirements.txt
|
| 81 |
+
```
|
| 82 |
+
|
| 83 |
+
4. **Configure credentials:**
|
| 84 |
+
```bash
|
| 85 |
+
FIREWORKS_API_KEY=tu_api_key_aqui
|
| 86 |
+
```
|
| 87 |
+
|
| 88 |
+
5. **Configurar las credenciales:**
|
| 89 |
+
```bash
|
| 90 |
+
FIREWORKS_API_KEY=your_api_key_here
|
| 91 |
+
```
|
| 92 |
+
|
| 93 |
+
6. **Run the application:**
|
| 94 |
+
```bash
|
| 95 |
+
Fpython app.py
|
| 96 |
+
```
|