Skip to content

Start documentation for internal workings of PyDough #336

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.

Sign up for GitHub

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

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

Start documentation for internal workings of PyDough #336

Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
1967c04
Create documentation for irs
knassre-bodo Apr 21, 2025
e41642d
Adding more sections
knassre-bodo Apr 21, 2025
2d1b01b
Adding first mermaid graph
knassre-bodo Apr 21, 2025
9480f6f
Reorienting flowchart
knassre-bodo Apr 21, 2025
0b40edb
Adding unqualified node diagram
knassre-bodo Apr 21, 2025
f9f4a74
Hybrid diagrams WIP
knassre-bodo Apr 21, 2025
7b7c3e5
Working on second hybrid doc
knassre-bodo Apr 22, 2025
c8a1794
Merge branch 'main' into kian/devdocs
knassre-bodo Apr 24, 2025
7a45407
Updated examples and added decorrelation
knassre-bodo Apr 24, 2025
f414994
Fixing typo
knassre-bodo Apr 24, 2025
90c506c
Merge branch 'main' into kian/devdocs
knassre-bodo Apr 25, 2025
3b23d0f
Adding first relational example
knassre-bodo Apr 25, 2025
89cf690
Filling out more sections to the IR guide [RUN CI]
knassre-bodo Apr 28, 2025
5ae61fa
Adding big important boxes around the TODO sections
knassre-bodo Apr 28, 2025
246d47c
Moving around seciton
knassre-bodo Apr 28, 2025
513c176
Adding missing backticks
knassre-bodo Apr 28, 2025
961fc25
Apply suggestions from code review
knassre-bodo May 6, 2025
13e82a8
Further revisions
knassre-bodo May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ testing, the `tpch.db` file must be located in the `tests` directory.
Additionally, the [`setup_defog.sh`](https://github.com/bodo-ai/PyDough/blob/main/tests/setup_defog.sh)
script must be run so that the `defog.db` file is located in the `tests` directory.

To learn more about the implementation of PyDough in order to modify it, read about the various [IRs used within PyDough](https://github.com/bodo-ai/PyDough/blob/main/documentation/ir.md)

## Running CI Tests

To run our CI tests on your PR, you must include the flag `[run CI]` in latest
Expand Down
Loading