Legal_Expert_Contract_Advisor_Using_Precision_RAG

Sistema de RAP de contrato de preguntas y respuestas

Descripción general

Este proyecto tiene como objetivo desarrollar un sistema de expertos legales de alta precisión para las preguntas y respuestas de contratos utilizando la generación de recuperación acuática (RAG). El sistema aprovecha las técnicas avanzadas de procesamiento del lenguaje natural (PNL) para proporcionar respuestas precisas y conscientes del contexto a preguntas sobre contratos legales e integra un poderoso modelo de lenguaje con un mecanismo de recuperación personalizado para proporcionar respuestas precisas y contextualmente relevantes a consultas relacionadas con el contrato.

Tabla de contenido

• Descripción general
• Estructura de proyectos
• Instalación
• Uso
• Desarrollo
• Evaluación
• Técnicas de optimización
• Que contribuye
• Licencia
• Expresiones de gratitud
• Contacto

Características

• Tubería de generación de recuperación de la generación (RAG) para preguntas y respuestas de contrato
• Componentes personalizables de retriever y generador
• Marco de evaluación utilizando métricas de ragas
• Técnicas de optimización para mejorar el rendimiento

Estructura de proyectos

 Legal_Expert_Contract_Advisor_Using_Precision_RAG/
├── data/
│   ├── raw/
│   ├── processed/
│   └── evaluation/
├── notebooks/
│   ├── 1_data_exploration.ipynb
│   ├── 2_rag_implementation.ipynb
│   └── 3_evaluation_and_optimization.ipynb
├── src/
│   ├── data/
│   │   ├── __init__.py
│   │   ├── preprocess.py
│   │   └── load_data.py
│   ├── models/
│   │   ├── __init__.py
│   │   ├── retriever.py
│   │   └── generator.py
│   ├── evaluation/
│   │   ├── __init__.py
│   │   └── metrics.py
│   └── utils/
│       ├── __init__.py
│       └── helpers.py
├── tests/
│   ├── test_data.py
│   ├── test_models.py
│   └── test_evaluation.py
├── config.yaml
├── requirements.txt
├── setup.py
├── main.py
├── .gitignore
└── README.md

• data/ : contiene archivos de datos sin procesar y procesados
• notebooks/ : cuadernos de Jupyter para exploración, implementación y evaluación
• src/ : código fuente para el sistema RAG
  • data/ : Scripts de carga y preprocesamiento de datos
  • models/ : implementaciones de modelo de retrie y generador
  • evaluation/ : Métricas de evaluación y scripts
  • utils/ : Funciones y utilidades auxiliares
• tests/ : pruebas unitarias para varios componentes
• config.yaml : archivo de configuración para la configuración del proyecto
• requirements.txt : lista de dependencias de proyectos
• setup.py : script de configuración para el proyecto
• main.py : punto de entrada principal para ejecutar el sistema RAG

Instalación

1. Clonar el repositorio

git clone https://github.com/dev-abuke/Legal_Expert_Contract_Advisor_Using_Precision_RAG.git

2. Navegue al directorio de proyectos

 cd Legal_Expert_Contract_Advisor_Using_Precision_RAG

3. Crear un entorno virtual

python -m venv venv

4. Activar el entorno

 source venv/bin/activate  # On Windows, use venvScriptsactivate

3. Instale las dependencias requeridas:

pip install -r requirements.txt

Uso

1. Prepare los datos de su contrato y colóquelo en los data/raw/ Directorio.

2. Preprocesar los datos

python src/data/preprocess.py

3. Ejecutar el sistema de trapo

python main.py

4. Evaluar el rendimiento del sistema:

python src/evaluation/evaluate.py

Desarrollo

• Use los cuadernos Jupyter en los notebooks/ directorio para exploración y creación de prototipos.
• Implementar la funcionalidad central en el directorio src/ .
• Agregue pruebas unitarias en las tests/ directorio.
• Use config.yaml para administrar la configuración del proyecto.

Evaluación

El rendimiento del sistema se evalúa utilizando las siguientes métricas

• Precisión y retiro de recuperación
• Respuesta de relevancia
• Precisión objetiva
• Coherencia de respuesta

Consulte el cuaderno de evaluación para obtener resultados y análisis detallados.

Técnicas de optimización

Este proyecto explora varias técnicas de optimización, incluidas

1. Modelos de incrustación avanzados para la recuperación
2. Métodos de búsqueda híbridos
3. Expansión de la consulta
4. Estrategias de fragmentación
5. Ingeniería rápida

Que contribuye

Las contribuciones para mejorar el sistema son bienvenidas. Siga estos pasos:

1. Bifurca el repositorio
2. Cree una nueva sucursal ( git checkout -b feature/your-feature )
3. Haga sus cambios y confídos ( git commit -am 'Add new feature' )
4. Empuje a la rama ( git push origin feature/your-feature )
5. Crear una nueva solicitud de extracción

Licencia

Este proyecto tiene licencia bajo la licencia MIT; consulte el archivo de licencia para obtener más detalles.

Expresiones de gratitud

• 10 Academia para proporcionar el desafío y la oportunidad de aprendizaje
• Lizzyai para la inspiración y orientación del proyecto

Contacto

Para cualquier consulta, abra un problema en este repositorio o comuníquese con Abubeker Shamil.