Corregir README.md para usar API key en lugar de SDK y añadir archivos de configuración inicial

[Copilot]

Resumen

Este PR corrige la documentación del proyecto para reflejar que no se necesita ningún SDK específico para el Fine-Tuning de Google Gemini, sino que se puede trabajar directamente con la API key de Google. También añade los archivos de configuración inicial necesarios para el proyecto.

Cambios realizados

📝 README.md actualizado

• Eliminadas referencias al SDK: Se removieron menciones a gcloud CLI y dependencias de SDK
• Configuración con API key: Se actualizaron las instrucciones para usar directamente la API key de Google AI Studio
• Instrucciones claras: Se añadieron pasos detallados para obtener y configurar la API key
• Estructura del proyecto: Se documentó la estructura de archivos esperada

📦 requirements.txt creado

• google-generativeai>=0.3.0 - Biblioteca principal para interactuar con la API de Gemini
• python-dotenv>=1.0.0 - Gestión de variables de entorno para la API key
• pandas>=2.0.0 y numpy>=1.24.0 - Procesamiento de datos
• jsonschema>=4.17.0 - Validación de datos JSON
• scikit-learn>=1.3.0 - Métricas y evaluación futura del modelo

🔒 .gitignore añadido

• Protección de API keys: Excluye archivos .env y variantes
• Archivos Python: Ignora __pycache__/, archivos compilados, etc.
• Entornos virtuales: Excluye directorios venv/, env/
• IDEs y sistema: Ignora archivos de configuración de IDEs y archivos del sistema

Configuración actualizada

Antes (con SDK):

gcloud auth application-default login
# Configuración compleja con SDK

Después (con API key):

# Obtener API key de https://aistudio.google.com/app/apikey
echo "GOOGLE_API_KEY=tu_api_key_aqui" > .env

Verificación

✅ El archivo .env está correctamente excluido en .gitignore
✅ Las dependencias incluyen solo las necesarias para trabajar con la API
✅ Las instrucciones son claras y directas
✅ La estructura del proyecto está bien documentada

Este cambio simplifica significativamente la configuración del proyecto y elimina la dependencia del SDK de Google Cloud, haciendo que el proyecto sea más accesible para los desarrolladores.

This pull request was created as a result of the following prompt from Copilot chat.

El usuario ha hecho una aclaración importante: no se necesita ningún SDK específico para el Fine-Tuning de Google Gemini, sino que se puede trabajar directamente con la API key de Google. Necesito regenerar el archivo README.md corrigiendo las referencias al SDK y actualizando las instrucciones de configuración para usar la API key en lugar de gcloud CLI.

El contenido corregido del README.md es el siguiente:

# Fine-Tuning de Gemini para Corrección de Lenguaje de Signos

Este proyecto tiene como objetivo utilizar el Fine-Tuning del modelo Google Gemini para corregir y transformar el texto generado por un dispositivo de reconocimiento de lenguaje de signos. El problema principal del reconocedor es que produce palabras con letras repetidas (ej: "hhhhhhoooooollllllaaaaa" en lugar de "hola"), y este proyecto busca solucionar ese problema.

## Roadmap del Proyecto

El proyecto se dividirá en varias fases, cada una implementada a través de una Pull Request para su validación.

### Fase 1: Configuración del Proyecto y Generación de Datos
- **Objetivo:** Establecer la estructura del proyecto y crear un generador de datos sintéticos para el entrenamiento.
- **Tareas:**
    - [x] Crear un fichero `README.md` con la descripción del proyecto, el roadmap y las instrucciones.
    - [ ] Desarrollar un script en Python (`data_generator.py`) para generar un dataset de entrenamiento. Este script creará pares de frases/palabras incorrectas (con letras repetidas) y su versión corregida. Se incluirán ejemplos para manejar la ambigüedad de contexto (ej: "pera" vs "perra").

### Fase 2: Script de Fine-Tuning
- **Objetivo:** Implementar el script que realizará el Fine-Tuning del modelo Gemini.
- **Tareas:**
    - [ ] Implementar un script (`finetune.py`) que utilice la API de Google Gemini para entrenar un modelo con el dataset generado.

### Fase 3: Script de Inferencia y Corrección
- **Objetivo:** Crear una herramienta para utilizar el modelo entrenado.
- **Tareas:**
    - [ ] Crear un script (`corrector.py`) que cargue el modelo entrenado y lo utilice para corregir en tiempo real las palabras o frases de entrada.

### Fase 4: Evaluación del Modelo y Pruebas
- **Objetivo:** Evaluar el rendimiento del modelo y asegurar la calidad del código.
- **Tareas:**
    - [ ] Añadir funcionalidades para evaluar el rendimiento del modelo con un conjunto de datos de test y métricas de precisión.
    - [ ] Crear pruebas unitarias para los scripts principales.

## Configuración del Entorno

1. **Clonar el repositorio:**
   ```bash
   git clone https://github.com/alexcerezo/FineTuningSignLanguage.git
   cd FineTuningSignLanguage
   ```

2. **Crear un entorno virtual:**
   ```bash
   python -m venv venv
   source venv/bin/activate  # En Windows: venv\Scripts\activate
   ```

3. **Instalar las dependencias:**
   ```bash
   pip install -r requirements.txt
   ```

4. **Configurar la API Key de Google:**
   - Obtén tu API key de Google AI Studio (https://aistudio.google.com/app/apikey)
   - Crea un archivo `.env` en la raíz del proyecto con tu API key:
     ```
     GOOGLE_API_KEY=tu_api_key_aqui
     ```
   - **Importante:** Asegúrate de que el archivo `.env` esté incluido en `.gitignore` para no subir tu API key al repositorio.

## Estructura del Proyecto

```
FineTuningSignLanguage/
├── README.md
├── requirements.txt
├── .env (no incluir en git)
├── .gitignore
├── data_generator.py
├── finetune.py
├── corrector.py
├── datasets/
│   ├── training_data.json
│   └── test_data.json
└── models/
    └── (modelos entrenados)
```

## Uso del Proyecto

Una vez completado el desarrollo, el flujo de trabajo será:

1. **Generar datos de entrenamiento:**
   ```bash
   python data_generator.py
   ```

2. **Entrenar el modelo:**
   ```bash
   python finetune.py
   ```

3. **Corregir texto:**
   ```bash
   python corrector.py "hhhhhhoooooollllllaaaaa"
   ```

## Contribución

Este proyecto sigue un enfoque de desarrollo incremental. Cada fase se implementa a través de una Pull Request que debe ser revisada y aprobada antes de continuar con la siguiente fase.

Además, necesito crear un archivo requirements.txt inicial y un .gitignore apropiado para el proyecto.

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.