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

More documentation #203

Merged
merged 9 commits into from
Nov 2, 2021
Merged

More documentation #203

merged 9 commits into from
Nov 2, 2021

Conversation

alongreyber
Copy link
Contributor

Added high level documentation overviews for execution and planning. These are good for onboarding onto the project. Couldn't quite finish the planning documentation but got pretty close to done.

@patrickkwang patrickkwang requested review from davefol, kennethmorton and maximusunc and removed request for patrickkwang October 29, 2021 13:21
docs/COMPONENTS.md Outdated Show resolved Hide resolved
docs/COMPONENTS.md Show resolved Hide resolved
docs/COMPONENTS.md Show resolved Hide resolved
docs/COMPONENTS.md Outdated Show resolved Hide resolved
docs/PLANNING_OVERVIEW.md Show resolved Hide resolved
@alongreyber
Copy link
Contributor Author

This PR looks good except that the docs/PLANNING_OVERVIEW.md document is very out of date. I don't really have a good grasp on how the new query planning works. @uhbrar would you be able to update that document? Patrick wrote the docs/QUERY_PLANNING.md document but that isn't really an overview of how it works–it's specifically focused on some statistical optimization stuff. I think that a planning overview for people new to the code would be helpful to have.

If you also don't know how it works I can dive in and learn about it but I thought I would ask.

@alongreyber
Copy link
Contributor Author

@davefol I made a milestone for cleaning up dead code so feel free to create issues and link them to it

@davefol
Copy link
Contributor

davefol commented Oct 31, 2021

This PR looks good except that the docs/PLANNING_OVERVIEW.md document is very out of date. I don't really have a good grasp on how the new query planning works. @uhbrar would you be able to update that document? Patrick wrote the docs/QUERY_PLANNING.md document but that isn't really an overview of how it works–it's specifically focused on some statistical optimization stuff. I think that a planning overview for people new to the code would be helpful to have.

If you also don't know how it works I can dive in and learn about it but I thought I would ask.

perfect is the enemy of good yada yada. I'll make an issue for updaating PLANNING_OVERVIEW.md and tentatively assign @uhbrar to it. I don't want it to block this PR because this is a lot of really good stuff.

@kennethmorton
Copy link
Collaborator

I think I might have the clearest (remaining) picture of the query planning algorithm. I'll put this on my list for documentation.

From my current understanding the algorithm we have is pretty solid, and shouldn't need to be overhauled for a while, but we might want to add a few bells and whistles. However those bells and whistles don't offer as much as optimizations elsewhere right now.

@davefol
Copy link
Contributor

davefol commented Nov 1, 2021

I'll add @kennethmorton to the assigned members for issue #321

@uhbrar
Copy link
Collaborator

uhbrar commented Nov 2, 2021

I'll take a look at it as well, although I don't actually know how it works precisely, except for some parts that Patrick shared with me before he left. That being said, besides Kenny, I might have the best chance of getting it fully figured out, and it'll be a good opportunity to look through the code and learn about it for me anyway.

@alongreyber alongreyber force-pushed the more-documentation branch 2 times, most recently from d5d9490 to 390b4ab Compare November 2, 2021 14:17
@alongreyber alongreyber merged commit ff02506 into master Nov 2, 2021
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.

6 participants