kanshan/graphrag
1
0
Fork 0
mirror of https://github.com/microsoft/graphrag.git synced 2026-01-14 09:07:20 +08:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Add missing config parameter for prompt tuning docs (#1017)

Browse Source
This commit is contained in:
Alonso Guevara 2024-08-26 14:38:59 -06:00 committed by GitHub
parent fd8e56ce6f
commit 4c2f5376a8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.semversioner/next-release/patch-20240823234457512331.json Normal file
View File

@ -0,0 +1,4 @@
{
"type": "patch",
"description": "Add missing config parameter documentation for prompt tuning"
}

6
docsite/posts/prompt_tuning/auto_prompt_tuning.md
View File

@ -24,6 +24,8 @@ python -m graphrag.prompt_tune [--root ROOT] [--domain DOMAIN] [--method METHOD
## Command-Line Options
- `--config` (required): The path to the configuration file. This is required to load the data and model settings.
- `--root` (optional): The data project root directory, including the config files (YML, JSON, or .env). Defaults to the current directory.
- `--domain` (optional): The domain related to your input data, such as 'space science', 'microbiology', or 'environmental news'. If left empty, the domain will be inferred from the input data.
@ -45,13 +47,13 @@ python -m graphrag.prompt_tune [--root ROOT] [--domain DOMAIN] [--method METHOD
## Example Usage
```bash
python -m graphrag.prompt_tune --root /path/to/project --domain "environmental news" --method random --limit 10 --language English --max-tokens 2048 --chunk-size 256 --no-entity-types --output /path/to/output
python -m graphrag.prompt_tune --root /path/to/project --config /path/to/settings.yaml --domain "environmental news" --method random --limit 10 --language English --max-tokens 2048 --chunk-size 256 --no-entity-types --output /path/to/output
```
or, with minimal configuration (suggested):
```bash
python -m graphrag.prompt_tune --root /path/to/project --no-entity-types
python -m graphrag.prompt_tune --root /path/to/project --config /path/to/settings.yaml --no-entity-types
```
## Document Selection Methods