Update README.md

This commit is contained in:
Kevin 2025-10-01 19:45:15 +01:00 committed by GitHub
parent dc84962862
commit cb0c928fa9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -90,26 +90,7 @@ Fill in your **API credentials** in `gpt_config.json`.
We provide two shell scripts for different generation modes:
#### (a) Full Benchmark Mode
Script: `run_agent.sh`
Runs all (or a subset of) learning topics defined in `long_video_topics_list.json`.
```bash
sh run_agent.sh
```
**Important parameters inside `run_agent.sh`:**
* `API`: specify which LLM to use.
* `FOLDER_PREFIX`: name prefix for saving output folders (e.g., `TEST-LIST`).
* `MAX_CONCEPTS`: number of concepts to include (`-1` means all).
* `PARALLEL_GROUP_NUM`: number of groups to run in parallel.
---
#### (b) Single Knowledge Point Mode
#### (a) Any Query
Script: `run_agent_single.sh`
@ -127,6 +108,23 @@ sh run_agent_single.sh --knowledge_point "Linear transformations and matrices"
---
#### (b) Full Benchmark Mode
Script: `run_agent.sh`
Runs all (or a subset of) learning topics defined in `long_video_topics_list.json`.
```bash
sh run_agent.sh
```
**Important parameters inside `run_agent.sh`:**
* `API`: specify which LLM to use.
* `FOLDER_PREFIX`: name prefix for saving output folders (e.g., `TEST-LIST`).
* `MAX_CONCEPTS`: number of concepts to include (`-1` means all).
* `PARALLEL_GROUP_NUM`: number of groups to run in parallel.
### 4. Project Organization
A suggested directory structure: