Skip to content

Comments

Add comprehensive README.md with project description and roadmap#1

Merged
alexcerezo merged 1 commit intomainfrom
copilot/fix-0f4e840b-4e9e-4c84-888f-121ff8220109
Jul 20, 2025
Merged

Add comprehensive README.md with project description and roadmap#1
alexcerezo merged 1 commit intomainfrom
copilot/fix-0f4e840b-4e9e-4c84-888f-121ff8220109

Conversation

Copy link

Copilot AI commented Jul 20, 2025

This PR adds a comprehensive README.md file to establish the project foundation and documentation for the Fine-Tuning Sign Language project.

Changes Made

  • Added complete project description: Documents the objective of using Google Gemini Fine-Tuning to correct sign language recognition text that contains repeated letters (e.g., "hhhhhhoooooollllllaaaaa" → "hola")

  • Implemented detailed 4-phase roadmap:

    • Phase 1: Project setup and synthetic data generation
    • Phase 2: Fine-tuning script implementation
    • Phase 3: Inference and correction tools
    • Phase 4: Model evaluation and testing
  • Added environment setup instructions: Complete guide for:

    • Repository cloning
    • Virtual environment creation
    • Dependency installation
    • Google Cloud credentials configuration
  • Marked first milestone as complete: The README.md creation task in Phase 1 is now checked off as completed

Project Structure

The README establishes the foundation for a structured development approach where each phase will be implemented through separate Pull Requests for proper validation and review.

Next Steps

With this README in place, the next task in Phase 1 will be developing the data_generator.py script to create synthetic training datasets with repeated letter patterns and their corrections.

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

El usuario ha aprobado el plan de trabajo. El primer paso es crear un archivo README.md que contenga la descripción del proyecto, el roadmap definido y las instrucciones de configuración inicial.

El contenido 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 el SDK 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 las credenciales de Google Cloud:**
   - Asegúrate de tener `gcloud` CLI instalado y configurado.
   - Autentícate con el siguiente comando:
     ```bash
     gcloud auth application-default login
     ```

Por favor, crea una pull request para añadir este archivo README.md al repositorio.


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

@alexcerezo alexcerezo marked this pull request as ready for review July 20, 2025 08:45
@alexcerezo alexcerezo merged commit f85a5f3 into main Jul 20, 2025
2 checks passed
Copilot AI changed the title [WIP] Fase 1: Añadir README.md con la definición del proyecto Add comprehensive README.md with project description and roadmap Jul 20, 2025
Copilot AI requested a review from alexcerezo July 20, 2025 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants