Alejo760 commited on
Commit
316f56f
·
verified ·
1 Parent(s): bb919d6

Upload 4 files

Browse files
Files changed (4) hide show
  1. LICENSE +21 -0
  2. README.md +99 -13
  3. UdeA+simplificado-01.png +0 -0
  4. requirements.txt +13 -0
LICENSE ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ MIT License
2
+
3
+ Copyright (c) 2024 alejo760
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
README.md CHANGED
@@ -1,13 +1,99 @@
1
- ---
2
- title: Microcurriculum UdeA
3
- emoji: 🔥
4
- colorFrom: purple
5
- colorTo: green
6
- sdk: streamlit
7
- sdk_version: 1.39.0
8
- app_file: app.py
9
- pinned: false
10
- license: mit
11
- ---
12
-
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+ ![Logo UdeA](UdeA+simplificado-01.png)
3
+
4
+ # 🩺 Microcurriculum UdeA con IA
5
+
6
+ Bienvenido al proyecto **Microcurriculum UdeA con IA**. Esta aplicación utiliza inteligencia artificial para ayudar en la creación y mejora de microcurrículos para cursos de pregrado y posgrado en la Universidad de Antioquia.
7
+
8
+ ## 🚀 Descripción
9
+
10
+ Este proyecto es una herramienta interactiva desarrollada con Streamlit que permite a los docentes:
11
+
12
+ - **Crear** microcurrículos completos ingresando información relevante sobre el curso.
13
+ - **Mejorar** secciones específicas del microcurrículo utilizando inteligencia artificial y fragmentos del PEI-UdeA.
14
+ - **Descargar** el microcurrículo generado en formato Word (`.docx`).
15
+
16
+ La aplicación utiliza modelos de lenguaje avanzados y bases de datos vectoriales para proporcionar sugerencias y mejoras en las diferentes secciones del microcurrículo.
17
+
18
+ ## 🛠️ Tecnologías Utilizadas
19
+
20
+ - **Python**
21
+ - **Streamlit**: para la interfaz web.
22
+ - **LangChain**: para el manejo de modelos de lenguaje y embeddings.
23
+ - **ChromaDB**: como base de datos vectorial.
24
+ - **Groq**: para interactuar con modelos de lenguaje avanzados.
25
+ - **Python-docx**: para la generación de documentos Word.
26
+
27
+ ## 📦 Instalación
28
+
29
+ 1. **Clonar el repositorio:**
30
+
31
+ ```bash
32
+ git clone https://github.com/tu_usuario/microcurriculum-udea.git
33
+ cd microcurriculum-udea
34
+ ```
35
+
36
+ 2. **Crear un entorno virtual e instalar dependencias:**
37
+
38
+ ```bash
39
+ python -m venv env
40
+ source env/bin/activate # En Windows: env\Scripts\activate
41
+ pip install -r requirements.txt
42
+ ```
43
+
44
+ 3. **Configurar la clave API de Groq**
45
+
46
+ Necesitarás una clave API de Groq para poder utilizar el modelo de IA. Puedes obtenerla registrándote en la plataforma de Groq.
47
+
48
+ Agrega la clave API a tu archivo `secrets.toml` de Streamlit de la siguiente manera:
49
+
50
+ ```toml
51
+ [API]
52
+ API_KEY = "tu_clave_api_de_groq"
53
+ ```
54
+
55
+ 4. **Ejecutar la aplicación:**
56
+
57
+ ```bash
58
+ streamlit run app.py
59
+ ```
60
+
61
+ ## ✨ Características
62
+
63
+ - **IA para Mejora Automática**: Utiliza la tecnología de inteligencia artificial de Groq para mejorar secciones del microcurrículo basadas en el PEI de la universidad.
64
+ - **Facilidad de Uso**: La interfaz de usuario simple e intuitiva está diseñada para que cualquier docente pueda usarla sin complicaciones técnicas.
65
+ - **Personalización Completa**: Ajusta y mejora el microcurrículo con facilidad, y descarga el resultado final.
66
+
67
+ ## 📊 Estructura del Proyecto
68
+
69
+ - `app.py`: La aplicación principal de Streamlit.
70
+ - `create_vector_db.py`: Script para crear bases de datos vectoriales a partir de PDFs (PEI y guía).
71
+ - `requirements.txt`: Archivo con las dependencias necesarias para ejecutar la aplicación.
72
+ - `README.md`: Archivo de descripción del proyecto.
73
+
74
+ ## ✍️ Autor
75
+
76
+ Este trabajo experimental ha sido desarrollado por:
77
+
78
+ **Alejandro Hernández-Arango, MD, MSc**
79
+ Trabajo experimental para el diplomado de pedagogía, Universidad de Antioquia, 2024-2.
80
+ Correo: [alejandro.hernandeza@udea.edu.co](mailto:alejandro.hernandeza@udea.edu.co)
81
+
82
+ ## 🌐 Contacto y Redes
83
+ Alejandro Hernández-Arango MD Esp MSc
84
+ Internal Medicine, Digital Health and Telemedicine
85
+ Professor and Researcher in Artificial Intelligence
86
+ University of Antioquia
87
+ Medellín, Colombia.
88
+ Google Scholar | Research Gate
89
+
90
+
91
+ - **ResearchGate**: [Alejandro Hernández-Arango en ResearchGate](https://www.researchgate.net/profile/Alejandro-Hernandez-Arango)
92
+ - **Google Scholar**: [Alejandro Hernández-Arango en Google Scholar](https://scholar.google.com.pr/citations?user=IeUO9c8AAAAJ&hl=es&oi=ao)
93
+
94
+
95
+
96
+
97
+
98
+
99
+
UdeA+simplificado-01.png ADDED
requirements.txt ADDED
@@ -0,0 +1,13 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ streamlit
2
+ langchain>=0.0.298
3
+ langchain-huggingface
4
+ python-docx
5
+ chromadb>=0.4.0
6
+ groq
7
+ langchain-groq
8
+ transformers
9
+ torch
10
+ sentence-transformers
11
+ pysqlite3-binary
12
+ protobuf==3.20.3
13
+ duckdb>=0.7.1