Skip to content

Commit ff46f5a

Browse files
authored
chore: fix experimental blob docs (#1472)
1 parent 27ab028 commit ff46f5a

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

bigframes/operations/blob.py

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def uri(self) -> bigframes.series.Series:
4444
BigFrames Blob is still under experiments. It may not work and subject to change in the future.
4545
4646
Returns:
47-
BigFrames Series: URIs as string."""
47+
bigframes.series.Series: URIs as string."""
4848
s = bigframes.series.Series(self._block)
4949

5050
return s.struct.field("uri")
@@ -56,7 +56,7 @@ def authorizer(self) -> bigframes.series.Series:
5656
BigFrames Blob is still under experiments. It may not work and subject to change in the future.
5757
5858
Returns:
59-
BigFrames Series: Autorithers(connection) as string."""
59+
bigframes.series.Series: Autorithers(connection) as string."""
6060
s = bigframes.series.Series(self._block)
6161

6262
return s.struct.field("authorizer")
@@ -68,7 +68,7 @@ def version(self) -> bigframes.series.Series:
6868
BigFrames Blob is still under experiments. It may not work and subject to change in the future.
6969
7070
Returns:
71-
BigFrames Series: Version as string."""
71+
bigframes.series.Series: Version as string."""
7272
# version must be retrieved after fetching metadata
7373
return self._apply_unary_op(ops.obj_fetch_metadata_op).struct.field("version")
7474

@@ -79,7 +79,7 @@ def metadata(self) -> bigframes.series.Series:
7979
BigFrames Blob is still under experiments. It may not work and subject to change in the future.
8080
8181
Returns:
82-
BigFrames Series: JSON metadata of the Blob. Contains fields: content_type, md5_hash, size and updated(time)."""
82+
bigframes.series.Series: JSON metadata of the Blob. Contains fields: content_type, md5_hash, size and updated(time)."""
8383
details_json = self._apply_unary_op(ops.obj_fetch_metadata_op).struct.field(
8484
"details"
8585
)
@@ -94,7 +94,7 @@ def content_type(self) -> bigframes.series.Series:
9494
BigFrames Blob is still under experiments. It may not work and subject to change in the future.
9595
9696
Returns:
97-
BigFrames Series: string of the content type."""
97+
bigframes.series.Series: string of the content type."""
9898
return (
9999
self.metadata()
100100
._apply_unary_op(ops.JSONValue(json_path="$.content_type"))
@@ -108,7 +108,7 @@ def md5_hash(self) -> bigframes.series.Series:
108108
BigFrames Blob is still under experiments. It may not work and subject to change in the future.
109109
110110
Returns:
111-
BigFrames Series: string of the md5 hash."""
111+
bigframes.series.Series: string of the md5 hash."""
112112
return (
113113
self.metadata()
114114
._apply_unary_op(ops.JSONValue(json_path="$.md5_hash"))
@@ -122,7 +122,7 @@ def size(self) -> bigframes.series.Series:
122122
BigFrames Blob is still under experiments. It may not work and subject to change in the future.
123123
124124
Returns:
125-
BigFrames Series: file size in bytes."""
125+
bigframes.series.Series: file size in bytes."""
126126
return (
127127
self.metadata()
128128
._apply_unary_op(ops.JSONValue(json_path="$.size"))
@@ -137,7 +137,7 @@ def updated(self) -> bigframes.series.Series:
137137
BigFrames Blob is still under experiments. It may not work and subject to change in the future.
138138
139139
Returns:
140-
BigFrames Series: updated time as UTC datetime."""
140+
bigframes.series.Series: updated time as UTC datetime."""
141141
import bigframes.pandas as bpd
142142

143143
updated = (
@@ -159,7 +159,7 @@ def _get_runtime(
159159
metadata (bool, default False): whether to fetch the metadata in the ObjectRefRuntime.
160160
161161
Returns:
162-
bigframes Series: ObjectRefRuntime JSON.
162+
bigframes.series.Series: ObjectRefRuntime JSON.
163163
"""
164164
s = self._apply_unary_op(ops.obj_fetch_metadata_op) if with_metadata else self
165165

@@ -172,7 +172,7 @@ def read_url(self) -> bigframes.series.Series:
172172
BigFrames Blob is still under experiments. It may not work and subject to change in the future.
173173
174174
Returns:
175-
BigFrames Series: Read only URLs."""
175+
bigframes.series.Series: Read only URLs."""
176176
return self._get_runtime(mode="R")._apply_unary_op(
177177
ops.JSONValue(json_path="$.access_urls.read_url")
178178
)
@@ -184,7 +184,7 @@ def write_url(self) -> bigframes.series.Series:
184184
BigFrames Blob is still under experiments. It may not work and subject to change in the future.
185185
186186
Returns:
187-
BigFrames Series: Writable URLs."""
187+
bigframes.series.Series: Writable URLs."""
188188
return self._get_runtime(mode="RW")._apply_unary_op(
189189
ops.JSONValue(json_path="$.access_urls.write_url")
190190
)
@@ -303,7 +303,7 @@ def image_blur(
303303
container_memory (str, default "512Mi"): container memory size. String of the format <number><unit>. Possible values are from 512Mi to 32Gi.
304304
305305
Returns:
306-
BigFrames Blob Series
306+
bigframes.series.Series: blob Series if destination is GCS. Or bytes Series if destination is BQ.
307307
"""
308308
import bigframes.blob._functions as blob_func
309309

@@ -390,7 +390,7 @@ def image_resize(
390390
container_memory (str, default "512Mi"): container memory size. String of the format <number><unit>. Possible values are from 512Mi to 32Gi.
391391
392392
Returns:
393-
BigFrames Blob Series
393+
bigframes.series.Series: blob Series if destination is GCS. Or bytes Series if destination is BQ.
394394
"""
395395
dsize_set = dsize[0] > 0 and dsize[1] > 0
396396
fsize_set = fx > 0.0 and fy > 0.0
@@ -486,7 +486,7 @@ def image_normalize(
486486
container_memory (str, default "512Mi"): container memory size. String of the format <number><unit>. Possible values are from 512Mi to 32Gi.
487487
488488
Returns:
489-
BigFrames Blob Series
489+
bigframes.series.Series: blob Series if destination is GCS. Or bytes Series if destination is BQ.
490490
"""
491491
import bigframes.blob._functions as blob_func
492492

@@ -603,8 +603,7 @@ def pdf_chunk(
603603
arrays of strings.
604604
605605
.. note::
606-
BigFrames Blob is still under experiments. It may not work and
607-
subject to change in the future.
606+
BigFrames Blob is still under experiments. It may not work and subject to change in the future.
608607
609608
Args:
610609
connection (str or None, default None): BQ connection used for
@@ -621,7 +620,7 @@ def pdf_chunk(
621620
container_memory (str, default "512Mi"): container memory size. String of the format <number><unit>. Possible values are from 512Mi to 32Gi.
622621
623622
Returns:
624-
bigframe.series.Series of array[str], where each string is a
623+
bigframe.series.Series: Series of array[str], where each string is a
625624
chunk of text extracted from PDF.
626625
"""
627626

0 commit comments

Comments
 (0)