Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KylinMountain authored Aug 3, 2024
1 parent 2278a24 commit fd1f14e
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,44 @@

![image](https://github.com/user-attachments/assets/ab7a8d2e-aeec-4a0c-afb9-97086b9c7b2a)

# How to install如何安装
- 克隆本项目 Clone the repo
```
git clone https://github.com/KylinMountain/graphrag.git
cd graphrag
```
- 建立虚拟环境 Create virtual env
```
conda create -n graphrag python=3.10
conda activate graphrag
```
- 安装poetry Install poetry
```
curl -sSL https://install.python-poetry.org | python3 -
```
- 安装依赖 Install dependencies
```
poetry install
pip install -r webserver/requirements.txt
```
- 初始化GraphRAG Initialize GraphRAG
```
poetry run poe index --init --root .
```
- 创建input文件夹 Create Input Foler
- 配置settings.yaml Config settings.yaml
- 配置webserver Config webserver

你可能需要配置以下设置 You may need config the following item.
当前还不支持从settigns.yaml,但很快就会支持。Currently, we don't support read llm config from graphrag settings.yaml, but it is incoming.
```yaml
api_key: str = os.environ.get("DEEP_SEEK_API_KEY")
api_base: str = "https://api.deepseek.com/v1"
llm_model: str = "deepseek-chat"
embedding_model: str = "text-embedding-ada-002"
embedding_api_base: str = "http://localhost:1234/v1"
```
# GraphRAG
👉 [Use the GraphRAG Accelerator solution](https://github.com/Azure-Samples/graphrag-accelerator) <br/>
Expand Down

0 comments on commit fd1f14e

Please sign in to comment.