How programanacionalalgortimosverdes/pnav-hackathon-2 works
Para guiar al principal software engineer en la elaboración de un diagrama de arquitectura preciso para este repositorio de material del Hackathon, sigue estos pasos:
Identifica el tipo de proyecto y su propósito
• Proyecto: Repositorio de “Material para el Segundo Hackathon” (colección de guías PDF y Jupyter notebooks).
• Propósito: Proveer documentación, ejemplos de adquisición de datos, generación de datasets y notebooks de ayuda para procesos de inferencia, fine-tuning y seguimiento de consumo energético.
Analiza la estructura de archivos
• Top-level:
• .gitignore, README.md, requirements.txt, setup.py
• .images/ (logos)
• content/
• Dentro de content/ hay tres carpetas principales:
• 000_guides/: PDFs con instrucciones para participantes
• 100_data/: notebooks de adquisición y pre-procesamiento de datos
• 200_help/: notebooks de métodos de inferencia, fine-tune, medición de huella y uso de ALIA
Extrae información relevante del README
• Stack tecnológico: Python 3.12, módulos listados en requirements.txt.
• Flujo: desde obtención de datos via APIs (Eidos, Red Natura, GeoServer) hasta generación de QA datasets, entrenamiento y evaluación con métricas de consumo (CodeCarbon) y ejemplos de uso de ALIA.
Los componentes principales para el diagrama
a. Componentes internos
• Guías (PDF) → content/000_guides
• Pipelines de datos (Jupyter notebooks) → content/100_data
• Notebooks de ayuda a ML (inferencia, fine-tune, CodeCarbon, ALIA) → content/200_help
• Entorno de ejecución → Python 3.12 + Jupyter
• Dependencias y scripts de instalación → requirements.txt, setup.py
b. Componentes externos
• APIs de datos: Eidos, Red Natura, GeoServer
• Repositorios de modelos o infraestructuras de cómputo (opcional: dónde se corre el fine-tune/inferencia)
Relaciona e interactúa los componentes
• Las Guías proveen al usuario la metodología para:
→ Ejecutar notebooks de 100_data
→ Seguir notebooks de 200_help
• Los notebooks de 100_data consumen datos desde APIs externas y generan:
→ Datasets de QA (etapa intermedia)
→ Métricas de energía inicial
• Los notebooks de 200_help toman los datasets generados y:
→ Realizan inferencia y fine-tuning (posible integración con modelos de terceros)
→ Miden consumo via CodeCarbon
→ Muestran uso de ALIA
• El entorno Python/Jupyter sostiene la ejecución de todos los notebooks y gestiona dependencias.
Señala patrones y principios arquitectónicos
• Arquitectura en *pipeline* de datos: Ingestión → Procesamiento → Entrenamiento/Evaluación
• Separación clara en carpetas por responsabilidad (guías vs. datos vs. ayudas)
• Uso de notebooks interactivas como “micro-servicios” de procesamiento (aunque todos se ejecutan en un único entorno Jupyter)
Recomendaciones de diseño del diagrama
• Dibuja cajas rectangulares para cada componente (Guías, Notebooks de data, Notebooks de ayuda, Entorno, APIs externas).
• Utiliza flechas direccionales para indicar flujo de datos y dependencias:
• APIs externas → Notebooks 100_data
• Notebooks 100_data → Datasets generados → Notebooks 200_help
• Notebooks 200_help → Resultados / métricas
• Azul para componentes internos (carpetas/notebooks)
• Naranja para servicios externos (APIs)
• Gris claro para artefactos estáticos (PDFs, requirements)
• Etiqueta cada flecha con el tipo de dato o acción (e.g., “GET datos”, “export QA dataset”, “medir consumo”).
Elementos imprescindibles en el diagrama final
• Nombres claros de cada carpeta/componente (por ejemplo: content/100_data)
• Direcciones de las flechas que muestren flujo de información
• Leyenda o paleta de colores para distinguir tipos de componentes
• Inclusión de tecnologías clave (Python 3.12, Jupyter, CodeCarbon, ALIA)
Con este enfoque tendrás un diagrama claro, detallado y adaptado exactamente a la naturaleza de este proyecto de hackathon, reflejando tanto la estructura de contenidos como el flujo de trabajo de extremo a extremo.