Skip to content

Commit 46114d4

Browse files
docs: update README
1 parent de066e3 commit 46114d4

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,21 @@ It begins by constructing a fine-grained knowledge graph from the source text,
3838
Furthermore, GraphGen incorporates multi-hop neighborhood sampling to capture complex relational information and employs style-controlled generation to diversify the resulting QA data.
3939

4040
## 🚀 Quick Start
41-
[//]: # (TODO)
42-
43-
### Command Line
4441

4542
### Gradio Demo
4643

44+
1. Enter `webui` directory
45+
```bash
46+
cd webui
47+
```
48+
2. Run the Gradio demo
49+
```bash
50+
gradio app.py
51+
```
52+
53+
54+
### Run from PyPI
55+
4756
![ui](resources/images/interface.jpg)
4857

4958
### Run from Source
@@ -53,15 +62,17 @@ Furthermore, GraphGen incorporates multi-hop neighborhood sampling to capture co
5362
pip install -r requirements.txt
5463
```
5564
2. Configure the environment
56-
- Create a `.env` file in the root directory
65+
- Create an `.env` file in the root directory
5766
```bash
5867
cp .env.example .env
5968
```
6069
- Set the following environment variables:
6170
```bash
71+
# Synthesizer is the model used to construct KG and generate data
6272
SYNTHESIZER_MODEL=your_synthesizer_model_name
6373
SYNTHESIZER_BASE_URL=your_base_url_for_synthesizer_model
6474
SYNTHESIZER_API_KEY=your_api_key_for_synthesizer_model
75+
# Trainee is the model used to train with the generated data
6576
TRAINEE_MODEL=your_trainee_model_name
6677
TRAINEE_BASE_URL=your_base_url_for_trainee_model
6778
TRAINEE_API_KEY=your_api_key_for_trainee_model

0 commit comments

Comments
 (0)