@@ -6,15 +6,25 @@ BigQuery DataFrames (BigFrames)
66|GA | |pypi | |versions |
77
88BigQuery DataFrames (also known as BigFrames) provides a Pythonic DataFrame
9- and machine learning (ML) API powered by the BigQuery engine.
9+ and machine learning (ML) API powered by the BigQuery engine. It provides modules
10+ for many use cases, including:
1011
11- * `bigframes.pandas ` provides a pandas API for analytics. Many workloads can be
12+ * `bigframes.pandas <https://dataframes.bigquery.dev/reference/api/bigframes.pandas.html >`_
13+ is a pandas API for analytics. Many workloads can be
1214 migrated from pandas to bigframes by just changing a few imports.
13- * ``bigframes.ml `` provides a scikit-learn-like API for ML.
15+ * `bigframes.ml <https://dataframes.bigquery.dev/reference/index.html#ml-apis >`_
16+ is a scikit-learn-like API for ML.
17+ * `bigframes.bigquery.ai <https://dataframes.bigquery.dev/reference/api/bigframes.bigquery.ai.html >`_
18+ are a collection of powerful AI methods, powered by Gemini.
1419
15- BigQuery DataFrames is an open-source package.
20+ BigQuery DataFrames is an ` open-source package < https://github.com/googleapis/python-bigquery-dataframes >`_ .
1621
17- **Version 2.0 introduces breaking changes for improved security and performance. See below for details. **
22+ .. |GA | image :: https://img.shields.io/badge/support-GA-gold.svg
23+ :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#general-availability
24+ .. |pypi | image :: https://img.shields.io/pypi/v/bigframes.svg
25+ :target: https://pypi.org/project/bigframes/
26+ .. |versions | image :: https://img.shields.io/pypi/pyversions/bigframes.svg
27+ :target: https://pypi.org/project/bigframes/
1828
1929Getting started with BigQuery DataFrames
2030----------------------------------------
@@ -38,7 +48,8 @@ To use BigFrames in your local development environment,
3848
3949 import bigframes.pandas as bpd
4050
41- bpd.options.bigquery.project = your_gcp_project_id
51+ bpd.options.bigquery.project = your_gcp_project_id # Optional in BQ Studio.
52+ bpd.options.bigquery.ordering_mode = " partial" # Recommended for performance.
4253 df = bpd.read_gbq(" bigquery-public-data.usa_names.usa_1910_2013" )
4354 print (
4455 df.groupby(" name" )
@@ -48,49 +59,16 @@ To use BigFrames in your local development environment,
4859 .to_pandas()
4960 )
5061
51-
5262 Documentation
5363-------------
5464
5565To learn more about BigQuery DataFrames, visit these pages
5666
5767* `Introduction to BigQuery DataFrames (BigFrames) <https://cloud.google.com/bigquery/docs/bigquery-dataframes-introduction >`_
5868* `Sample notebooks <https://github.com/googleapis/python-bigquery-dataframes/tree/main/notebooks >`_
59- * `API reference <https://cloud.google.com/python/docs/reference/bigframes/latest/summary_overview >`_
69+ * `API reference <https://dataframes.bigquery.dev/ >`_
6070* `Source code (GitHub) <https://github.com/googleapis/python-bigquery-dataframes >`_
6171
62- ⚠️ Warning: Breaking Changes in BigQuery DataFrames v2.0
63- --------------------------------------------------------
64-
65- Version 2.0 introduces breaking changes for improved security and performance. Key default behaviors have changed, including
66-
67- * **Large Results (>10GB): ** The default value for ``allow_large_results `` has changed to ``False ``.
68- Methods like ``to_pandas() `` will now fail if the query result's compressed data size exceeds 10GB,
69- unless large results are explicitly permitted.
70- * **Remote Function Security: ** The library no longer automatically lets the Compute Engine default service
71- account become the identity of the Cloud Run functions. If that is desired, it has to be indicated by passing
72- ``cloud_function_service_account="default" ``. And network ingress now defaults to ``"internal-only" ``.
73- * **@remote_function Argument Passing: ** Arguments other than ``input_types ``, ``output_type ``, and ``dataset ``
74- to ``remote_function `` must now be passed using keyword syntax, as positional arguments are no longer supported.
75- * **@udf Argument Passing: ** Arguments ``dataset `` and ``name `` to ``udf `` are now mandatory.
76- * **Endpoint Connections: ** Automatic fallback to locational endpoints in certain regions is removed.
77- * **LLM Updates (Gemini Integration): ** Integrations now default to the ``gemini-2.0-flash-001 `` model.
78- PaLM2 support has been removed; please migrate any existing PaLM2 usage to Gemini. **Note: ** The current default
79- model will be removed in Version 3.0.
80-
81- **Important: ** If you are not ready to adapt to these changes, please pin your dependency to a version less than 2.0
82- (e.g., ``bigframes==1.42.0 ``) to avoid disruption.
83-
84- To learn about these changes and how to migrate to version 2.0, see the
85- `updated introduction guide <https://cloud.google.com/bigquery/docs/bigquery-dataframes-introduction >`_.
86-
87- .. |GA | image :: https://img.shields.io/badge/support-GA-gold.svg
88- :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#general-availability
89- .. |pypi | image :: https://img.shields.io/pypi/v/bigframes.svg
90- :target: https://pypi.org/project/bigframes/
91- .. |versions | image :: https://img.shields.io/pypi/pyversions/bigframes.svg
92- :target: https://pypi.org/project/bigframes/
93-
9472License
9573-------
9674
0 commit comments