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

docs(how-to): add a how-to guide for executing unbound expressions on backends #8522

Merged
merged 4 commits into from
Mar 6, 2024

Conversation

chloeh13q
Copy link
Contributor

Description of changes

Add a tutorial for executing unbound expressions on backends

Issues closed

Resolves #8297

@lostmygithubaccount lostmygithubaccount changed the title docs(tutorial): add a tutorial for executing unbound expressions on backends docs(how-to): add a tutorial for executing unbound expressions on backends Mar 2, 2024
@chloeh13q chloeh13q added the docs-preview Add this label to trigger a docs preview label Mar 3, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Mar 3, 2024
@chloeh13q chloeh13q marked this pull request as ready for review March 3, 2024 00:38
@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Mar 3, 2024

@kszucs
Copy link
Member

kszucs commented Mar 3, 2024

Thanks for working on this! Unbound expressions deserve more attention in the docs.


In Ibis, you can define unbound tables. An unbound table is a table with a
specified schema but not connected to a data source. You can think of it as an
empty CSV file with just the header.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find the CSV analogy a bit confusing :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rephrased slightly. Let me know if it's still confusing?

con.to_pandas(expr)
```

Voilà!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

docs/how-to/extending/unbound_expression.qmd Outdated Show resolved Hide resolved
docs/how-to/extending/unbound_expression.qmd Outdated Show resolved Hide resolved
Copy link
Member

@gforsyth gforsyth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking good, @chloeh13q ! A few small changes, then we can trigger a docs preview to take a look

docs/how-to/extending/unbound_expression.qmd Show resolved Hide resolved
docs/how-to/extending/unbound_expression.qmd Outdated Show resolved Hide resolved
docs/how-to/extending/unbound_expression.qmd Outdated Show resolved Hide resolved
docs/how-to/extending/unbound_expression.qmd Outdated Show resolved Hide resolved
@chloeh13q chloeh13q added the docs-preview Add this label to trigger a docs preview label Mar 5, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Mar 5, 2024
@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Mar 5, 2024

@chloeh13q chloeh13q requested a review from gforsyth March 5, 2024 21:45
Copy link
Member

@gforsyth gforsyth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good @chloeh13q -- I spotted one more small thing in the docs preview, but otherwise I think this is good to go.

docs/how-to/extending/unbound_expression.qmd Outdated Show resolved Hide resolved
@gforsyth
Copy link
Member

gforsyth commented Mar 5, 2024

ooooh, ok, this might be something for a followup PR, but it would be really cool to have a second ibis connection that can load in the same parquet data so you can show off executing the same unbound expression (and hammer home the separation of interface from engine)

@chloeh13q
Copy link
Contributor Author

@gforsyth Great point! I added another section to demo execution on Polars, but let me know if there's another backend that you think would complete the story better

@lostmygithubaccount lostmygithubaccount added docs Documentation related issues or PRs docs-preview Add this label to trigger a docs preview labels Mar 6, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Mar 6, 2024
@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Mar 6, 2024

@chloeh13q chloeh13q requested a review from gforsyth March 6, 2024 20:22
@lostmygithubaccount lostmygithubaccount changed the title docs(how-to): add a tutorial for executing unbound expressions on backends docs(how-to): add a how-to guide for executing unbound expressions on backends Mar 6, 2024
@gforsyth gforsyth merged commit 66b4dc0 into ibis-project:main Mar 6, 2024
20 checks passed
@cpcloud cpcloud added this to the 9.0 milestone Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related issues or PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: add an example/tutorial for executing unbound expressions on backends
5 participants