Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add --reports argument to Index CLI #1211

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

junho85
Copy link
Contributor

@junho85 junho85 commented Sep 25, 2024

Description

Implements --reports argument to the Index CLI, allowing users to specify a dedicated directory for reports. This enhances the flexibility of the pipeline configuration and decouples report directory management from output directory settings.

The --reports argument was mentioned in the documentation at

- `--reports <directory>` - Specify the output directory for reporting.
, but had not been implemented.

Related Issues

Proposed Changes

  • Implements --reports argument to the CLI

Checklist

  • I have tested these changes locally.
  • I have reviewed the code changes.
  • I have updated the documentation (if necessary).
  • I have added appropriate unit tests (if applicable).

Additional Notes

Implements `--reports` argument to the CLI, allowing users to specify a dedicated directory for reports. This enhances the flexibility of the pipeline configuration and decouples report directory management from output directory settings.

The `--reports` argument was mentioned in the documentation at https://github.com/microsoft/graphrag/blob/dda4edd0fd2ad2665045a1689f14e68a198d6a7a/docsite/posts/index/2-cli.md?plain=1#L28, but had not been implemented.
@junho85 junho85 requested review from a team as code owners September 25, 2024 14:58
@junho85 junho85 changed the title Implements reports directory argument to CLI Implements reports directory argument to Index CLI Sep 25, 2024
@jgbradley1 jgbradley1 changed the title Implements reports directory argument to Index CLI Add --reports argument to Index CLI Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant