From f264b0be8e07c06d29bf8a2fa3c502953b595d4f Mon Sep 17 00:00:00 2001 From: shibing624 Date: Fri, 6 Sep 2024 17:43:04 +0800 Subject: [PATCH] update readme --- README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index da09ba3..d7dc64d 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,9 @@ -## 使用说明 +## Usage -#### 安装依赖 +### 安装依赖 在终端中输入下面的命令,然后回车即可。 ```shell @@ -51,14 +51,24 @@ pip install -r requirements.txt 如果下载慢,建议配置豆瓣源。 -#### RAG示例 +### RAG示例 请使用下面的命令。取决于你的系统,你可能需要用python或者python3命令。请确保你已经安装了Python。 ```shell -CUDA_VISIBLE_DEVICES=0 python rag.py --gen_model_type auto --gen_model_name 01-ai/Yi-6B-Chat --corpus_files sample.pdf +CUDA_VISIBLE_DEVICES=0 python rag.py ``` -#### GraphRAG示例 + + +### 启动Gradio的Web服务 + +```shell +CUDA_VISIBLE_DEVICES=0 python webui.py --corpus_files data/sample.pdf --share +``` + +现在,你应该已经可以在浏览器地址栏中输入 http://localhost:7860 查看并使用 ChatPDF 了。 + +### GraphRAG示例 > [!TIP] > > **Please set OpenAI API key in environment: `export OPENAI_API_KEY="sk-..."`.** @@ -70,15 +80,6 @@ python graphrag_demo.py ``` -#### 启动Gradio的Web服务 - -```shell -CUDA_VISIBLE_DEVICES=0 python webui.py --gen_model_type auto --gen_model_name 01-ai/Yi-6B-Chat --corpus_files sample.pdf --share -``` - -现在,你应该已经可以在浏览器地址栏中输入 http://localhost:7860 查看并使用 ChatPDF 了。 - - ## Contact - Issue(建议):[![GitHub issues](https://img.shields.io/github/issues/shibing624/ChatPDF.svg)](https://github.com/shibing624/ChatPDF/issues)