yujunjun/graphrag
1
0
Fork 0
mirror of https://github.com/microsoft/graphrag.git synced 2025-12-12 15:31:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix img for autotune (#1060)

Browse Source 
* Fix img for autotune

* Add line breaks to tune docs

* More line breaks
This commit is contained in:
Alonso Guevara 2024-08-29 16:56:34 -06:00 committed by GitHub
parent 6fc452b954
commit 7ffce8d7ba
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -0,0 +1,4 @@
{
"type": "patch",
"description": "Fix img for auto tune"
}

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

@ -11,7 +11,7 @@ GraphRAG provides the ability to create domain adapted prompts for the generatio
These are generated by loading the inputs, splitting them into chunks (text units) and then running a series of LLM invocations and template substitutions to generate the final prompts. We suggest using the default values provided by the script, but in this page you'll find the detail of each in case you want to further explore and tweak the prompt tuning algorithm.
<p align="center">
<img src="../../img/auto-tune-diagram.png" alt="Figure 1: Auto Tuning Conceptual Diagram." width="450" align="center" />
<img src="../../../img/auto-tune-diagram.png" alt="Figure 1: Auto Tuning Conceptual Diagram." width="450" align="center" />
</p>
<p align="center">
Figure 1: Auto Tuning Conceptual Diagram.
@ -26,7 +26,9 @@ Before running auto tuning make sure you have already initialized your workspace
You can run the main script from the command line with various options:
```bash
python -m graphrag.prompt_tune [--root ROOT] [--domain DOMAIN] [--method METHOD] [--limit LIMIT] [--language LANGUAGE] [--max-tokens MAX_TOKENS] [--chunk-size CHUNK_SIZE] [--n-subset-max N_SUBSET_MAX] [--k K] [--min-examples-required MIN_EXAMPLES_REQUIRED] [--no-entity-types] [--output OUTPUT]
python -m graphrag.prompt_tune [--root ROOT] [--domain DOMAIN] [--method METHOD] [--limit LIMIT] [--language LANGUAGE] \
[--max-tokens MAX_TOKENS] [--chunk-size CHUNK_SIZE] [--n-subset-max N_SUBSET_MAX] [--k K] \
[--min-examples-required MIN_EXAMPLES_REQUIRED] [--no-entity-types] [--output OUTPUT]
```
## Command-Line Options
@ -60,7 +62,9 @@ python -m graphrag.prompt_tune [--root ROOT] [--domain DOMAIN] [--method METHOD
## Example Usage
```bash
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 --min-examples-required 3 --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 --min-examples-required 3 \
--no-entity-types --output /path/to/output
```
or, with minimal configuration (suggested):