MagooDB commited on
Commit
a1adbed
·
verified ·
1 Parent(s): b113f86

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +40 -26
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>Agente de IA Seguro para la Migración Automatizada de NVIDIA CUDA a AMD ROCm (HIP)</strong></p>
19
  </div>
20
 
21
  ---
22
 
23
- ## 📖 Sobre el Proyecto
24
 
25
- **ROCm-Sentinel** es una herramienta asistida por Inteligencia Artificial diseñada para romper el "vendor lock-in" en el desarrollo de software acelerado por hardware. Utilizando un flujo de trabajo agéntico (Agentic Workflow), la aplicación toma código nativo de NVIDIA CUDA y lo traduce automáticamente a AMD HIP (Heterogeneous-Compute Interface for Portability), garantizando una transición suave hacia el ecosistema de AMD ROCm.
26
 
27
- No solo actúa como un traductor sintáctico, sino que incorpora un **Auditor de Seguridad** autónomo que revisa el código generado en busca de fugas de memoria, problemas de paralelismo y optimizaciones específicas para arquitecturas AMD.
28
 
29
  ---
30
 
31
- ## 🎯 Metas y Visión
32
 
33
- 1. **Democratizar el Hardware:** Facilitar a los desarrolladores y empresas la migración de sus cargas de trabajo desde ecosistemas cerrados hacia plataformas abiertas y competitivas como AMD.
34
- 2. **Migración Segura (Zero-Leak):** Ir más allá del simple "buscar y reemplazar". Asegurar que el código resultante gestione correctamente la memoria unificada y los hilos en las GPUs de AMD.
35
- 3. **Flujo de Trabajo Interactivo:** Proveer una interfaz amigable donde el desarrollador actúe como supervisor (Human-in-the-Loop), guiando al agente a través de un chat en tiempo real.
36
 
37
  ---
38
 
39
- ## 🧠 Modelos de Lenguaje (Agentes IA)
40
 
41
- Nuestra arquitectura multi-agente (Traductor + Auditor) está potenciada por LLMs de última generación a través de la API de Fireworks AI.
42
 
43
- * 🟢 **Modelo Actual en Uso: `DeepSeek V3.1`**
44
- * Actualmente, el proyecto está configurado para ejecutarse sobre DeepSeek V3.1, un modelo altamente capaz con un razonamiento lógico excepcional y tiempos de respuesta ultrarrápidos para la demostración interactiva.
45
- * ⭐ **Modelo Recomendado: `Qwen2.5-Coder 32B Instruct`**
46
- * Para entornos de producción y repositorios de código complejos, **recomendamos fuertemente** cambiar la configuración al modelo Qwen 2.5 Coder. Al estar entrenado específicamente en sintaxis de programación profunda, ofrece una fidelidad superior en la traducción de punteros y directivas complejas de C++/CUDA.
47
 
48
  ---
49
 
50
- ## 🛠️ Tecnologías Utilizadas
51
 
52
- * **Python 3** - Lenguaje base.
53
- * **Gradio** - Construcción de la interfaz web interactiva.
54
- * **LangGraph & LangChain** - Orquestación del flujo de trabajo de los agentes (nodos y aristas).
55
- * **Fireworks AI** - Proveedor de inferencia Serverless de los modelos LLM de código abierto.
56
 
57
  ---
58
 
59
- ## ⚙️ Instalación y Uso Local
60
 
61
- Sigue estos pasos para desplegar ROCm-Sentinel en tu propia máquina:
62
 
63
- 1. **Clonar el repositorio:**
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. **Crear y activar un entorno virtual:**
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. **Instalar dependencias:**
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
+ ```