Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
This repository was archived by the owner on May 7, 2026. It is now read-only.

Commit 61a9484

Browse filesBrowse files
docs: Move readme content to new User Guide section (#2464)
1 parent a951249 commit 61a9484
Copy full SHA for 61a9484

4 files changed

+73-13Lines changed: 73 additions & 13 deletions

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎README.rst‎

Copy file name to clipboardExpand all lines: README.rst
+1-2Lines changed: 1 addition & 2 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
:orphan:
2-
31
BigQuery DataFrames (BigFrames)
42
===============================
53

4+
65
|GA| |pypi| |versions|
76

87
BigQuery DataFrames (also known as BigFrames) provides a Pythonic DataFrame
Collapse file

‎docs/conf.py‎

Copy file name to clipboardExpand all lines: docs/conf.py
+1-10Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@
118118
"samples/AUTHORING_GUIDE.md",
119119
"samples/CONTRIBUTING.md",
120120
"samples/snippets/README.rst",
121+
"README.rst", # used for include in overview.rst only
121122
]
122123

123124
# The reST default role (used for this markup: `text`) to use for all
@@ -163,16 +164,6 @@
163164
"logo": {
164165
"text": "BigQuery DataFrames (BigFrames)",
165166
},
166-
"external_links": [
167-
{
168-
"name": "Getting started",
169-
"url": "https://docs.cloud.google.com/bigquery/docs/dataframes-quickstart",
170-
},
171-
{
172-
"name": "User guide",
173-
"url": "https://docs.cloud.google.com/bigquery/docs/bigquery-dataframes-introduction",
174-
},
175-
],
176167
"analytics": {
177168
"google_analytics_id": "G-XVSRMCJ37X",
178169
},
Collapse file

‎docs/index.rst‎

Copy file name to clipboardExpand all lines: docs/index.rst
+60-1Lines changed: 60 additions & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,63 @@
1-
.. include:: README.rst
1+
.. BigQuery DataFrames documentation main file
2+
3+
Welcome to BigQuery DataFrames
4+
==============================
5+
6+
**BigQuery DataFrames** (``bigframes``) provides a Pythonic interface for data analysis that scales to petabytes. It gives you the best of both worlds: the familiar API of **pandas** and **scikit-learn**, powered by the distributed computing engine of **BigQuery**.
7+
8+
BigQuery DataFrames consists of three main components:
9+
10+
* **bigframes.pandas**: A pandas-compatible API for data exploration and transformation.
11+
* **bigframes.ml**: A scikit-learn-like interface for BigQuery ML, including integration with Gemini.
12+
* **bigframes.bigquery**: Specialized functions for managing BigQuery resources and deploying custom logic.
13+
14+
Why BigQuery DataFrames?
15+
------------------------
16+
17+
BigFrames allows you to process data where it lives. Instead of downloading massive datasets to your local machine, BigFrames translates your Python code into SQL and executes it across the BigQuery fleet.
18+
19+
* **Scalability:** Work with datasets that exceed local memory limits without complex refactoring.
20+
* **Collaboration & Extensibility:** Bridge the gap between Python and SQL. Deploy custom Python functions to BigQuery, making your logic accessible to SQL-based teammates and data analysts.
21+
* **Production-Ready Pipelines:** Move seamlessly from interactive notebooks to production. BigFrames simplifies data engineering by integrating with tools like **dbt** and **Airflow**, offering a simpler operational model than Spark.
22+
* **Security & Governance:** Keep your data within the BigQuery perimeter. Benefit from enterprise-grade security, auditing, and data governance throughout your entire Python workflow.
23+
* **Familiarity:** Use ``read_gbq``, ``merge``, ``groupby``, and ``pivot_table`` just like you do in pandas.
24+
25+
Quickstart
26+
----------
27+
28+
Install the library via pip:
29+
30+
.. code-block:: bash
31+
32+
pip install --upgrade bigframes
33+
34+
Load and aggregate a public dataset in just a few lines:
35+
36+
.. code-block:: python
37+
38+
import bigframes.pandas as bpd
39+
40+
# Load data from BigQuery
41+
df = bpd.read_gbq("bigquery-public-data.usa_names.usa_1910_2013")
42+
43+
# Perform familiar pandas operations at scale
44+
top_names = (
45+
df.groupby("name")
46+
.agg({"number": "sum"})
47+
.sort_values("number", ascending=False)
48+
.head(10)
49+
)
50+
51+
print(top_names.to_pandas())
52+
53+
54+
User Guide
55+
----------
56+
57+
.. toctree::
58+
:maxdepth: 2
59+
60+
user_guide/index
261

362
API reference
463
-------------
Collapse file

‎docs/user_guide/index.rst‎

Copy file name to clipboard
+11Lines changed: 11 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
User Guide
2+
**********
3+
4+
.. include:: ../README.rst
5+
6+
.. toctree::
7+
:caption: Guides
8+
:maxdepth: 1
9+
10+
Getting Started <https://docs.cloud.google.com/bigquery/docs/dataframes-quickstart>
11+
Cloud Docs User Guides <https://docs.cloud.google.com/bigquery/docs/bigquery-dataframes-introduction>

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.