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.

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

Jump to bottom

[DOCS] Change show_optimized kwarg to show_all #1874

Merged
merged 1 commit into from
Feb 13, 2024
Merged

[DOCS] Change show_optimized kwarg to show_all #1874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 1 addition & 1 deletion docs/source/user_guide/basic_concepts/dataframe_introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ In this case, Daft is just deferring the work required to read the data and sele

When you call methods on a Daft Dataframe, it defers the work by adding to an internal "plan". You can examine the current plan of a DataFrame by calling :meth:`df.explain() <daft.DataFrame.explain>`!

Passing the ``show_optimized=True`` argument will show you the plan after Daft applies its query optimizations, and passing ``include_physical=True`` will also show you the physical (lower-level) plan.
Passing the ``show_all=True`` argument will show you the plan after Daft applies its query optimizations and the physical (lower-level) plan.

We can tell Daft to execute our DataFrame and cache the results using :meth:`df.collect() <daft.DataFrame.collect>`:

Expand Down
6 changes: 3 additions & 3 deletions tutorials/image_querying/top_n_red_color.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@
"source": [
"Doing these two `Filter`s one after another is really inefficient since we have to pass through the data twice!\n",
"\n",
"Don't worry though - Daft's query optimizer will actually optimize this at runtime and merge the two `Filter` operations into one. You can view the optimized plan with `show_optimized=True`:"
"Don't worry though - Daft's query optimizer will actually optimize this at runtime and merge the two `Filter` operations into one. You can view the optimized plan with `show_all=True`:"
]
},
{
Expand All @@ -230,7 +230,7 @@
},
"outputs": [],
"source": [
"df.explain(show_optimized=True)"
"df.explain(show_all=True)"
]
},
{
Expand Down Expand Up @@ -500,7 +500,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.9"
"version": "3.9.18"
},
"vscode": {
"interpreter": {
Expand Down
4 changes: 2 additions & 2 deletions tutorials/intro.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@
"outputs": [],
"source": [
"# df.explain()\n",
"# df.explain(show_optimized=True)"
"# df.explain(show_all=True)"
]
},
{
Expand Down Expand Up @@ -294,7 +294,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.9"
"version": "3.9.18"
},
"orig_nbformat": 4
},
Expand Down
Loading