CommQA-RAG

project_description
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

About The Project

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, repo_name, twitter_handle, linkedin_username, email_client, email, project_title, project_description

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• anaconda

Installation

1. Get a free API Key at https://bigmodel.cn/
2. Clone the repo

   git clone https://github.com/Cherish/CommQA-RAG

3. create conda env

   conda create CommQA-RAG
   conda activate CommQA-RAG

4. install requirement(The version of cuda is 11.8)

   pip install -r requirements.txt

5. create .env and Enter your API in .env

   ZHIPUAI_API_KEY='ENTER YOUR API';

6. download bge-large-zh-v.15

   git clone https://huggingface.co/BAAI/bge-large-zh-v1.5

(back to top)

Usage

1.下载并导入main.tex  

2.运行VectorBase.py (注意更改模型和文件名)完成后会生成vectors.json与bge_vectors.json

3.运行src/main.py即可

4.若要测试数据请运行src/test.py

(back to top)

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)