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: add docstring returns section #937

Merged
merged 21 commits into from
Sep 5, 2024
Merged
Changes from 3 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
65e8144
docs: add docstring returns section
arwas11 Aug 28, 2024
1cf100d
docs: add docstring returns section
arwas11 Aug 28, 2024
1e29edc
Merge remote-tracking branch 'refs/remotes/origin/b296390934-docstrin…
arwas11 Aug 30, 2024
38b06e2
deps: re-introduce support for numpy 1.24.x (#931)
tswast Aug 28, 2024
934a393
test: stop checking text generation contents (#935)
GarrettWu Aug 28, 2024
fc595d3
fix: unordered mode errors in ml train_test_split (#925)
GarrettWu Aug 28, 2024
dfe9bf0
docs: add Claude3 ML and RemoteFunc notebooks (#930)
GarrettWu Aug 28, 2024
5814b72
refactor: Extract data loading logic into class (#913)
TrevorBergeron Aug 28, 2024
5b7f7ef
chre: add tpch q19-22 and benchmark readme (#929)
Genesis929 Aug 29, 2024
67feb82
chore: add tpch q4-8 (#926)
Genesis929 Aug 29, 2024
5851d1e
chore: add tpch q14-18 (#928)
Genesis929 Aug 29, 2024
aa57995
deps: Update minimum support to Pandas 1.5.3 and Pyarrow 10.0.1 (#903)
chelsea-lin Aug 30, 2024
a602c7d
test: add CSV sample data file for testing (#938)
chelsea-lin Aug 30, 2024
c7c5be7
perf: Improve repr performance (#918)
TrevorBergeron Aug 30, 2024
ada83c3
docs: add docstring returns section
arwas11 Aug 28, 2024
71ae129
docs: add docstring returns section
arwas11 Aug 28, 2024
40b7e0f
Merge branch 'main' into b296390934-docstrings-type-annotation
arwas11 Sep 4, 2024
8c662c3
Merge branch 'main' into b296390934-docstrings-type-annotation
arwas11 Sep 4, 2024
2e7dfb7
Merge branch 'main' into b296390934-docstrings-type-annotation
arwas11 Sep 5, 2024
36a4a72
Merge branch 'main' into b296390934-docstrings-type-annotation
tswast Sep 5, 2024
522111b
Merge branch 'main' into b296390934-docstrings-type-annotation
arwas11 Sep 5, 2024
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
30 changes: 27 additions & 3 deletions bigframes/_config/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,12 @@ def _init_bigquery_thread_local(self):

@property
def bigquery(self) -> bigquery_options.BigQueryOptions:
"""Options to use with the BigQuery engine."""
"""Options to use with the BigQuery engine.

Returns:
bigframes._config.bigquery_options.BigQueryOptions:
Options for BigQuery engine.
"""
if self._local.bigquery_options is not None:
# The only way we can get here is if someone called
# _init_bigquery_thread_local.
Expand All @@ -83,7 +88,12 @@ def bigquery(self) -> bigquery_options.BigQueryOptions:

@property
def display(self) -> display_options.DisplayOptions:
"""Options controlling object representation."""
"""Options controlling object representation.

Returns:
bigframes._config.display_options.DisplayOptions:
Options for controlling object representaion.
"""
return self._local.display_options

@property
Expand All @@ -95,12 +105,21 @@ def sampling(self) -> sampling_options.SamplingOptions:
(e.g., to_pandas, to_numpy, values) or implicitly (e.g.,
matplotlib plotting). This option can be overriden by
parameters in specific functions.

Returns:
bigframes._config.sampling_options.SamplingOptions:
Options for controlling downsampling.
arwas11 marked this conversation as resolved.
Show resolved Hide resolved
"""
return self._local.sampling_options

@property
def compute(self) -> compute_options.ComputeOptions:
"""Thread-local options controlling object computation."""
"""Thread-local options controlling object computation.

Returns:
bigframes._config.compute_options.ComputeOptions:
Thread-local options for controlling object computation
arwas11 marked this conversation as resolved.
Show resolved Hide resolved
"""
return self._local.compute_options

@property
Expand All @@ -109,6 +128,11 @@ def is_bigquery_thread_local(self) -> bool:

A thread-local session can be started by using
`with bigframes.option_context("bigquery.some_option", "some-value"):`.

Returns:
bool:
A boolean value, where a value is True if a thread-local session
arwas11 marked this conversation as resolved.
Show resolved Hide resolved
is in use; otherwise False.
"""
return self._local.bigquery_options is not None

Expand Down