Skip to content

Commit

Permalink
Add missing config parameter for prompt tuning docs (#1017)
Browse files Browse the repository at this point in the history
  • Loading branch information
AlonsoGuevara authored Aug 26, 2024
1 parent fd8e56c commit 4c2f537
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
4 changes: 4 additions & 0 deletions .semversioner/next-release/patch-20240823234457512331.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"type": "patch",
"description": "Add missing config parameter documentation for prompt tuning"
}
6 changes: 4 additions & 2 deletions docsite/posts/prompt_tuning/auto_prompt_tuning.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down

0 comments on commit 4c2f537

Please sign in to comment.