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

Artifact cleanup #1341

Merged
merged 92 commits into from
Nov 13, 2024
Merged

Artifact cleanup #1341

merged 92 commits into from
Nov 13, 2024

Conversation

natoverse
Copy link
Collaborator

Cleans up a large number of duplicated or unused fields in the output artifacts, and renames a few things for consistency.

@natoverse natoverse requested a review from a team as a code owner October 31, 2024 23:07
graphrag/api/query.py Outdated Show resolved Hide resolved
@jgbradley1
Copy link
Collaborator

Now that the column names have been cleaned up quite a bit, is this a good PR to add docstrings to each workflow step to document the expected schema of the input/output dataframes?

As an alternative approach to docstrings, what do you think about using pydantic models to reference and validate the schema of each dataframe?

AlonsoGuevara
AlonsoGuevara previously approved these changes Nov 13, 2024
@natoverse
Copy link
Collaborator Author

Now that the column names have been cleaned up quite a bit, is this a good PR to add docstrings to each workflow step to document the expected schema of the input/output dataframes?

As an alternative approach to docstrings, what do you think about using pydantic models to reference and validate the schema of each dataframe?

I would much prefer Pydantic models, as I've noticed some of those docstrings were out of date anyway. We can add that at any time though I think. FWIW, I also added a docs page for the parquet schemas to help answer user questions.

@natoverse natoverse merged commit c8c354e into main Nov 13, 2024
15 checks passed
@natoverse natoverse deleted the artifact-cleanup branch November 13, 2024 23:11
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.

4 participants