From 5a7f18877790397a26727518d44601d264455d93 Mon Sep 17 00:00:00 2001 From: Garrett Wu Date: Wed, 26 Mar 2025 17:51:25 +0000 Subject: [PATCH 1/3] chore: expose blob docs --- bigframes/operations/blob.py | 7 +++++++ docs/reference/bigframes.pandas/series.rst | 9 +++++++++ 2 files changed, 16 insertions(+) diff --git a/bigframes/operations/blob.py b/bigframes/operations/blob.py index 7c0b6d4d1c..e763f0d2b5 100644 --- a/bigframes/operations/blob.py +++ b/bigframes/operations/blob.py @@ -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() diff --git a/docs/reference/bigframes.pandas/series.rst b/docs/reference/bigframes.pandas/series.rst index 547b262591..7ef8030f03 100644 --- a/docs/reference/bigframes.pandas/series.rst +++ b/docs/reference/bigframes.pandas/series.rst @@ -51,6 +51,15 @@ Struct handling :inherited-members: :undoc-members: +Blob handling +^^^^^^^^^^^^^ + +.. autoclass:: bigframes.operations.blob + :members: + :inherited-members: + :undoc-members: + + Plotting handling ^^^^^^^^^^^^^^^^^ From ebf10c2bd1002b0becdda9c5e8b1c5a7cc0a7202 Mon Sep 17 00:00:00 2001 From: Garrett Wu Date: Wed, 26 Mar 2025 17:59:05 +0000 Subject: [PATCH 2/3] include semantic and ai --- docs/reference/bigframes.pandas/series.rst | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/reference/bigframes.pandas/series.rst b/docs/reference/bigframes.pandas/series.rst index 7ef8030f03..dcee6f670b 100644 --- a/docs/reference/bigframes.pandas/series.rst +++ b/docs/reference/bigframes.pandas/series.rst @@ -54,11 +54,26 @@ Struct handling Blob handling ^^^^^^^^^^^^^ -.. autoclass:: bigframes.operations.blob +.. automodule:: bigframes.operations.blob :members: :inherited-members: :undoc-members: +Semantics handling +^^^^^^^^^^^^^^^^^^ + +.. automodule:: bigframes.operations.semantics + :members: + :inherited-members: + :undoc-members: + +Ai handling +^^^^^^^^^^^ + +.. automodule:: bigframes.operations.ai + :members: + :inherited-members: + :undoc-members: Plotting handling ^^^^^^^^^^^^^^^^^ From 518b6d83f6012d74b5f5aaf5149da55365df1046 Mon Sep 17 00:00:00 2001 From: Garrett Wu Date: Wed, 26 Mar 2025 18:03:45 +0000 Subject: [PATCH 3/3] exclude sem and ai, already in frames --- docs/reference/bigframes.pandas/series.rst | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/docs/reference/bigframes.pandas/series.rst b/docs/reference/bigframes.pandas/series.rst index dcee6f670b..3cfb7d89dd 100644 --- a/docs/reference/bigframes.pandas/series.rst +++ b/docs/reference/bigframes.pandas/series.rst @@ -59,22 +59,6 @@ Blob handling :inherited-members: :undoc-members: -Semantics handling -^^^^^^^^^^^^^^^^^^ - -.. automodule:: bigframes.operations.semantics - :members: - :inherited-members: - :undoc-members: - -Ai handling -^^^^^^^^^^^ - -.. automodule:: bigframes.operations.ai - :members: - :inherited-members: - :undoc-members: - Plotting handling ^^^^^^^^^^^^^^^^^