Skip to content

docs: fix the DisplayOptions doc rendering #893

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

Merged
merged 1 commit into from
Aug 8, 2024
Merged

docs: fix the DisplayOptions doc rendering #893

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
8 changes: 8 additions & 0 deletions third_party/bigframes_vendored/pandas/core/config_init.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
**Examples:**

Define Repr mode to "deferred" will prevent job execution in repr.

>>> import bigframes.pandas as bpd
>>> df = bpd.read_gbq("bigquery-public-data.ml_datasets.penguins")

Expand All @@ -26,25 +27,32 @@
Computation deferred. Computation will process 28.9 kB

Users can also get a dry run of the job by accessing the query_job property before they've run the job. This will return a dry run instance of the job they can inspect.

>>> df.query_job.total_bytes_processed
28947

User can execute the job by calling .to_pandas()

>>> # df.to_pandas()

Reset repr_mode option

>>> bpd.options.display.repr_mode = "head"

Can also set the progress_bar option to see the progress bar in terminal,

>>> bpd.options.display.progress_bar = "terminal"

notebook,

>>> bpd.options.display.progress_bar = "notebook"

or just remove it.

>>> bpd.options.display.progress_bar = None

Setting to default value "auto" will detect and show progress bar automatically.

>>> bpd.options.display.progress_bar = "auto"

Attributes:
Expand Down