Skip to content

chore: expose Series.blob accessor docs #1546

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 3 commits into from
Mar 26, 2025
Merged

chore: expose Series.blob accessor docs #1546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a7f188
chore: expose blob docs
GarrettWu Mar 26, 2025
ebf10c2
include semantic and ai
GarrettWu Mar 26, 2025
518b6d8
exclude sem and ai, already in frames
GarrettWu Mar 26, 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
7 changes: 7 additions & 0 deletions bigframes/operations/blob.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,13 @@

@log_adapter.class_logger
class BlobAccessor(base.SeriesMethods):
"""
Blob functions for Series and Index.

.. note::
BigFrames Blob is still under experiments. It may not work and subject to change in the future.
"""

def __init__(self, *args, **kwargs):
if not bigframes.options.experiments.blob:
raise NotImplementedError()
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/bigframes.pandas/series.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,14 @@ Struct handling
:inherited-members:
:undoc-members:

Blob handling
^^^^^^^^^^^^^

.. automodule:: bigframes.operations.blob
:members:
:inherited-members:
:undoc-members:

Plotting handling
^^^^^^^^^^^^^^^^^

Expand Down