Legal_Expert_Contract_Advisor_Using_Precision_RAG

合同问答抹布系统

概述

该项目旨在使用检索型发电（RAG）开发一种用于合同问答的高精度法律专家系统。该系统利用先进的自然语言处理（NLP）技术为有关法律合同的问题提供准确和上下文感知的答案，并将强大的语言模型与自定义检索机制相结合，以提供与合同相关查询的准确和上下文相关的答案。

目录

• 概述
• 项目结构
• 安装
• 用法
• 发展
• 评估
• 优化技术
• 贡献
• 执照
• 致谢
• 接触

特征

• 合同问答的检索授权生成（RAG）管道
• 可自定义的检索器和发电机组件
• 使用Ragas指标的评估框架
• 优化技术以提高性能

项目结构

 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/ ：包含原始的和处理过的数据文件
• notebooks/ ：用于探索，实施和评估的jupyter笔记本
• src/ ：抹布系统的源代码
  • data/ ：数据加载和预处理脚本
  • models/ ：检索器和生成器模型实现
  • evaluation/ ：评估指标和脚本
  • utils/ ：辅助功能和实用程序
• tests/ ：各种组件的单元测试
• config.yaml ：项目设置的配置文件
• requirements.txt ：项目依赖性列表
• setup.py ：项目的设置脚本
• main.py ：运行抹布系统的主要入口点

安装

1. 克隆存储库

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

2. 导航到项目目录

 cd Legal_Expert_Contract_Advisor_Using_Precision_RAG

3. 创建虚拟环境

python -m venv venv

4. 激活环境

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

3. 安装所需的依赖项：

pip install -r requirements.txt

用法

1. 准备您的合同数据并将其放入data/raw/目录中。

2. 预处理数据

python src/data/preprocess.py

3. 运行抹布系统

python main.py

4. 评估系统性能：

python src/evaluation/evaluate.py

发展

• 使用notebooks/目录中的jupyter笔记本进行探索和原型制作。
• 在src/目录中实现核心功能。
• 在tests/目录中添加单元测试。
• 使用config.yaml管理项目设置。

评估

使用以下指标评估系统的性能

• 检索精度和召回
• 回答相关性
• 事实准确性
• 响应相干

有关详细的结果和分析，请参阅评估笔记本。

优化技术

该项目探讨了各种优化技术，包括

1. 检索的高级嵌入模型
2. 混合搜索方法
3. 查询扩展
4. 分块策略
5. 及时的工程

贡献

欢迎改善系统的贡献。请按照以下步骤操作：

1. 分叉存储库
2. 创建一个新的分支（ git checkout -b feature/your-feature ）
3. 进行更改并提交它们（ git commit -am 'Add new feature' ）
4. 推到分支（ git push origin feature/your-feature ）
5. 创建一个新的拉请请求

执照

该项目是根据MIT许可证获得许可的 - 有关详细信息，请参见许可证文件。

致谢

• 10学院提供挑战和学习机会
• Lizzyai的项目灵感和指导

接触

有关任何查询，请在此存储库上打开一个问题，或联系Abubeker Shamil。