rogarces85 commited on
Commit
c9c2e9e
·
verified ·
1 Parent(s): 3bcd6b5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -200
README.md CHANGED
@@ -1,210 +1,26 @@
1
- ---
2
- title: Osorno Runners
3
- emoji: 🏃‍♂️
4
- colorFrom: red
5
- colorTo: purple
6
- sdk: gradio
7
- sdk_version: "4.19.2"
8
- app_file: app.py
9
- pinned: false
10
- ---
11
 
12
- # 🏃‍♂️ Osorno Runners - Sistema de Planes de Entrenamiento
13
 
14
- Sistema profesional para crear y gestionar planes de entrenamiento personalizados para corredores.
15
 
16
- ## 🚀 Características
17
 
18
- - Generación automática de planes de entrenamiento
19
- - Base de datos SQLite persistente
20
- - Sistema de autenticación (Usuario/Admin)
21
- - Exportación a PDF
22
- - ✅ Cálculo de zonas de frecuencia cardíaca
23
- - ✅ IMC y datos antropométricos
24
- - ✅ Cross training integrado
25
- - ✅ Carreras preparatorias
26
- - ✅ Mensajes motivacionales personalizados
27
 
28
- ## 📦 Tecnologías
29
 
30
- - **Frontend**: HTML, CSS, JavaScript
31
- - **Backend**: Python + Gradio
32
- - **Base de Datos**: SQLite
33
- - **Hosting**: HuggingFace Spaces
34
 
35
- ## 🔐 Credenciales por Defecto
36
 
37
- ### Usuario Regular
38
- - **Usuario**: USER
39
- - **Contraseña**: 123
40
- - **Permisos**: Ver planes propios
41
 
42
- ### Administrador
43
- - **Usuario**: ADMIN
44
- - **Contraseña**: 123
45
- - **Permisos**: Crear, ver y eliminar todos los planes
46
 
47
- ## 🏗️ Estructura del Proyecto
48
-
49
- ```
50
- osorno-runners-hf/
51
- ├── app.py # Aplicación principal Gradio
52
- ├── index.html # Frontend
53
- ├── requirements.txt # Dependencias Python
54
- ├── README.md # Este archivo
55
- └── osorno_runners.db # Base de datos SQLite (se crea automáticamente)
56
- ```
57
-
58
- ## 🚀 Despliegue en HuggingFace Spaces
59
-
60
- ### Paso 1: Crear Space
61
-
62
- 1. Ve a [HuggingFace Spaces](https://huggingface.co/spaces)
63
- 2. Click en "Create new Space"
64
- 3. Nombre: `osorno-runners` (o el que prefieras)
65
- 4. SDK: **Gradio**
66
- 5. Visibility: Public o Private
67
- 6. Click "Create Space"
68
-
69
- ### Paso 2: Subir Archivos
70
-
71
- **Opción A - Mediante la interfaz web:**
72
- 1. Click en "Files" en tu Space
73
- 2. Click "Add file" → "Upload files"
74
- 3. Arrastra todos los archivos del proyecto
75
-
76
- **Opción B - Mediante Git:**
77
- ```bash
78
- git clone https://huggingface.co/spaces/TU_USUARIO/osorno-runners
79
- cd osorno-runners
80
- # Copia los archivos del proyecto aquí
81
- git add .
82
- git commit -m "Initial commit"
83
- git push
84
- ```
85
-
86
- ### Paso 3: Configuración
87
-
88
- El Space se desplegará automáticamente. La base de datos SQLite se creará en el primer inicio.
89
-
90
- ## 💻 Desarrollo Local
91
-
92
- ```bash
93
- # Instalar dependencias
94
- pip install -r requirements.txt
95
-
96
- # Ejecutar aplicación
97
- python app.py
98
-
99
- # Abrir navegador en http://localhost:7860
100
- ```
101
-
102
- ## 📊 Base de Datos
103
-
104
- ### Tabla: planes
105
- ```sql
106
- CREATE TABLE planes (
107
- id INTEGER PRIMARY KEY AUTOINCREMENT,
108
- plan_data TEXT NOT NULL,
109
- created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
110
- created_by TEXT NOT NULL,
111
- athlete_name TEXT NOT NULL,
112
- distance TEXT NOT NULL,
113
- race_date TEXT NOT NULL
114
- )
115
- ```
116
-
117
- ### Tabla: users
118
- ```sql
119
- CREATE TABLE users (
120
- username TEXT PRIMARY KEY,
121
- password TEXT NOT NULL,
122
- role TEXT NOT NULL,
123
- name TEXT NOT NULL
124
- )
125
- ```
126
-
127
- ## 🎯 Funcionalidades Principales
128
-
129
- ### Generación de Planes
130
- - Cálculo automático de duración según distancia y experiencia
131
- - Periodización (Base, Específico, Competencia, Transición)
132
- - Distribución inteligente de volumen
133
- - Zonas de FC personalizadas (Karvonen)
134
-
135
- ### Tipos de Sesiones
136
- - Trote continuo base
137
- - Intervalos de velocidad
138
- - Tempo run
139
- - Long run (carrera larga)
140
- - Recuperación activa
141
- - Cross training
142
-
143
- ### Exportación PDF
144
- - Diseño profesional
145
- - Toda la información del atleta
146
- - Desglose semanal completo
147
- - Zonas de frecuencia cardíaca
148
-
149
- ## 🔧 Personalización
150
-
151
- ### Agregar Nuevos Usuarios
152
- Edita `app.py` en la función `init_db()`:
153
-
154
- ```python
155
- cursor.execute("INSERT INTO users VALUES ('NUEVO_USER', 'pass123', 'user', 'Nombre')")
156
- ```
157
-
158
- ### Modificar Algoritmos
159
- Los algoritmos de generación están en `index.html` en las funciones JavaScript:
160
- - `calculateWeeks()`: Duración del plan
161
- - `getBaseKm()`: Kilometraje base
162
- - `generateWeekSessions()`: Sesiones semanales
163
-
164
- ## 📈 Mejoras Futuras
165
-
166
- - [ ] Integración con IA (HuggingFace Inference API)
167
- - [ ] Análisis de progreso
168
- - [ ] Gráficos de volumen
169
- - [ ] Exportar a Google Calendar
170
- - [ ] Notificaciones por email
171
- - [ ] Versión móvil nativa
172
-
173
- ## 🤝 Contribuciones
174
-
175
- Las contribuciones son bienvenidas. Por favor:
176
- 1. Fork el repositorio
177
- 2. Crea una rama para tu feature
178
- 3. Commit tus cambios
179
- 4. Push a la rama
180
- 5. Abre un Pull Request
181
-
182
- ## 📄 Licencia
183
-
184
- MIT License
185
-
186
- ## 👨‍💻 Autor
187
-
188
- Desarrollado para Osorno Runners
189
-
190
- ## 🐛 Reporte de Bugs
191
-
192
- Si encuentras algún bug, por favor:
193
- 1. Ve a la pestaña "Community" del Space
194
- 2. Abre una nueva discusión
195
- 3. Describe el problema detalladamente
196
-
197
- ## ⚡ Notas Importantes
198
-
199
- - La base de datos SQLite es persistente en HuggingFace Spaces
200
- - Los datos se mantienen entre reinicios del Space
201
- - Para backup, descarga `osorno_runners.db` desde Files
202
- - Máximo 50MB de almacenamiento en plan gratuito
203
-
204
- ## 🌟 Showcase
205
-
206
- Ejemplo de uso: [Demo en vivo](https://huggingface.co/spaces/TU_USUARIO/osorno-runners)
207
-
208
- ---
209
-
210
- **¡Dale una ⭐ si te gusta el proyecto!**
 
1
+ # OR_Training — Running Plan Builder
 
 
 
 
 
 
 
 
 
2
 
 
3
 
4
+ Este Space usa el dataset `ncbi_extracted_running` y genera planes básicos de entrenamiento según datos del usuario.
5
 
 
6
 
7
+ ## Usar tu copia del dataset
8
+ 1. Entra a: https://huggingface.co/datasets/florentgbelidji/ncbi_extracted_running
9
+ 2. Click en **Dataset card → Duplicate** (o clona y empuja por git LFS) para crear `rogarces85/ncbi_extracted_running`.
10
+ 3. La app intentará cargar `rogarces85/ncbi_extracted_running` y, si no existe, usará el dataset original de florentgbelidji.
 
 
 
 
 
11
 
 
12
 
13
+ ## Guardar envíos
14
+ - Crea un **dataset repo** vacío llamado `OR_Training_submissions` en tu cuenta.
15
+ - En el Space, ve a **Settings Variables** y agrega `HUGGINGFACE_TOKEN` con permiso de escritura.
16
+ - Cada envío se agrega como una línea JSON en `OR_Training_submissions/submissions.jsonl`.
17
 
 
18
 
19
+ ## Ejecutar
20
+ - Sube estos archivos (`app.py`, `plan_generator.py`, `requirements.txt`, `README.md`) al Space `rogarces85/OR_Training`.
21
+ - El Space instalará dependencias y lanzará Gradio automáticamente.
 
22
 
 
 
 
 
23
 
24
+ ## Campos del dataset
25
+ - Columnas esperadas: `id`, `text`, `title`, `date`, `authors`, `language` (split `train`).
26
+ - La búsqueda simple usa substring en `title` y `text`.