Skip to content

Commit 4af147d

Browse files
docs: update README
1 parent 8dc68ec commit 4af147d

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed

README.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,35 @@ Furthermore, GraphGen incorporates multi-hop neighborhood sampling to capture co
5353
pip install -r requirements.txt
5454
```
5555
2. Configure the environment
56-
```bash
57-
cp configs/llm_config.yaml.example configs/llm_config.yaml
56+
- Create a `.env` file in the root directory
57+
```bash
58+
cp .env.example .env
59+
```
60+
- Set the following environment variables:
61+
```bash
62+
SYNTHESIZER_MODEL=your_synthesizer_model_name
63+
SYNTHESIZER_BASE_URL=your_base_url_for_synthesizer_model
64+
SYNTHESIZER_API_KEY=your_api_key_for_synthesizer_model
65+
TRAINEE_MODEL=your_trainee_model_name
66+
TRAINEE_BASE_URL=your_base_url_for_trainee_model
67+
TRAINEE_API_KEY=your_api_key_for_trainee_model
68+
```
69+
3. (Optional) If you want to modify the default generated configuration, you can edit the content of the configs/graphgen_config.yaml file.
70+
```yaml
71+
# configs/graphgen_config.yaml
72+
# Example configuration
73+
data_type: "raw"
74+
input_file: "resources/examples/raw_demo.jsonl"
75+
# more configurations...
5876
```
59-
77+
4. Run the generation script
78+
```bash
79+
bash scripts/generate.sh
80+
```
81+
5. Get the generated data
82+
```bash
83+
ls cache/data/graphgen
84+
```
6085

6186

6287
## 📌 Latest Updates

0 commit comments

Comments
 (0)