From 4c2f5376a80e0b028518a952190a6ddf40aeb490 Mon Sep 17 00:00:00 2001 From: Alonso Guevara Date: Mon, 26 Aug 2024 14:38:59 -0600 Subject: [PATCH] Add missing config parameter for prompt tuning docs (#1017) --- .semversioner/next-release/patch-20240823234457512331.json | 4 ++++ docsite/posts/prompt_tuning/auto_prompt_tuning.md | 6 ++++-- 2 files changed, 8 insertions(+), 2 deletions(-) create mode 100644 .semversioner/next-release/patch-20240823234457512331.json diff --git a/.semversioner/next-release/patch-20240823234457512331.json b/.semversioner/next-release/patch-20240823234457512331.json new file mode 100644 index 00000000..9371514d --- /dev/null +++ b/.semversioner/next-release/patch-20240823234457512331.json @@ -0,0 +1,4 @@ +{ + "type": "patch", + "description": "Add missing config parameter documentation for prompt tuning" +} diff --git a/docsite/posts/prompt_tuning/auto_prompt_tuning.md b/docsite/posts/prompt_tuning/auto_prompt_tuning.md index 88b74188..2ee23fe1 100644 --- a/docsite/posts/prompt_tuning/auto_prompt_tuning.md +++ b/docsite/posts/prompt_tuning/auto_prompt_tuning.md @@ -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