mirror of
https://github.com/microsoft/graphrag.git
synced 2025-11-15 17:44:37 +00:00
3b09df6e07
* Migrate towards using static output directories
- Fixes load_config eagering resolving directories.
Directories are only resolved when the output
directories are local.
- Add support for `--output` and `--reporting` flags
for index CLI. To achieve previous output structure
`index --output run1/artifacts --reports run1/reports`.
- Use static output directories when initializing
a new project.
- Maintains backward compatibility for those using
timestamp outputs locally.
* fix smoke tests
* update query cli to work with static directories
* remove eager path resolution from load_config. Support CLI overrides that can be resolved.
* add docs and output logs/artifacts to same directory
* use match statement
* switch back to if statement
---------
Co-authored-by: Alonso Guevara <alonsog@microsoft.com>
36 lines
1.1 KiB
Markdown
36 lines
1.1 KiB
Markdown
# Config Breaking Changes
|
|
|
|
## Deprecate timestamp paths
|
|
|
|
### Change
|
|
|
|
- Remove support for timestamp paths, those using `${timestamp}` directory nesting.
|
|
- Use the same directory for storage output and reporting output.
|
|
|
|
### Migration
|
|
|
|
- Ensure output directories no longer use `${timestamp}` directory nesting.
|
|
|
|
**Using Environment Variables**
|
|
|
|
- Ensure `GRAPHRAG_STORAGE_BASE_DIR` is set to a static directory, e.g., `output` instead of `output/${timestamp}/artifacts`.
|
|
- Ensure `GRAPHRAG_REPORTING_BASE_DIR` is set to a static directory, e.g., `output` instead of `output/${timestamp}/reports`
|
|
|
|
[Full docs on using environment variables for configuration](https://microsoft.github.io/graphrag/posts/config/env_vars/).
|
|
|
|
**Using Configuration File**
|
|
|
|
```yaml
|
|
# rest of settings.yaml file
|
|
# ...
|
|
|
|
storage:
|
|
type: file
|
|
base_dir: "output" # changed from "output/${timestamp}/artifacts"
|
|
|
|
reporting:
|
|
type: file
|
|
base_dir: "output" # changed from "output/${timestamp}/reports"
|
|
```
|
|
|
|
[Full docs on using JSON or YAML files for configuration](https://microsoft.github.io/graphrag/posts/config/json_yaml/). |