mirror of
https://github.com/microsoft/graphrag.git
synced 2025-11-25 06:26:27 +00:00
fc9895f793
* Replace docs by mkdocs-material * Fix markdown * Fix verions in gh-pages workflow * remove whitespaces * add semver * Add build docs check on python-ci * Fix command in index cli * Spellcheck * Spellcheck * remove docsite paths * clear outputs from notebook * remove dependabot npm for docsite * remove more docsite left overs * execute notebooks * Update notebooks * update poetry lock * Remove notebook build from ci * Revert dep update * Navigation tabs * Fix stylesheet * add kwds to dictionary * Turn on notebook execution * Update gitignore * Add MSR Blog posts * spellcheck * Accessibility Changes --------- Co-authored-by: Alonso Guevara <alonsog@microsoft.com>
33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
# Configuring GraphRAG Indexing
|
|
|
|
To start using GraphRAG, you need to configure the system. The `init` command is the easiest way to get started. It will create a `.env` and `settings.yaml` files in the specified directory with the necessary configuration settings. It will also output the default LLM prompts used by GraphRAG.
|
|
|
|
## Usage
|
|
|
|
```sh
|
|
python -m graphrag.index [--init] [--root PATH]
|
|
```
|
|
|
|
## Options
|
|
|
|
- `--init` - Initialize the directory with the necessary configuration files.
|
|
- `--root PATH` - The root directory to initialize. Default is the current directory.
|
|
|
|
## Example
|
|
|
|
```sh
|
|
python -m graphrag.index --init --root ./ragtest
|
|
```
|
|
|
|
## Output
|
|
|
|
The `init` command will create the following files in the specified directory:
|
|
|
|
- `settings.yaml` - The configuration settings file. This file contains the configuration settings for GraphRAG.
|
|
- `.env` - The environment variables file. These are referenced in the `settings.yaml` file.
|
|
- `prompts/` - The LLM prompts folder. This contains the default prompts used by GraphRAG, you can modify them or run the [Auto Prompt Tuning](../prompt_tuning/auto_prompt_tuning.md) command to generate new prompts adapted to your data.
|
|
|
|
## Next Steps
|
|
|
|
After initializing your workspace, you can either run the [Prompt Tuning](../prompt_tuning/auto_prompt_tuning.md) command to adapt the prompts to your data or even start running the [Indexing Pipeline](../index/overview.md) to index your data. For more information on configuring GraphRAG, see the [Configuration](overview.md) documentation.
|