-
Notifications
You must be signed in to change notification settings - Fork 68
docs: Move readme content to new User Guide section #2464
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
Merged
+73
−13
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,63 @@ | ||
| .. include:: README.rst | ||
| .. BigQuery DataFrames documentation main file | ||
|
|
||
| Welcome to BigQuery DataFrames | ||
| ============================== | ||
|
|
||
| **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**. | ||
|
|
||
| BigQuery DataFrames consists of three main components: | ||
|
|
||
| * **bigframes.pandas**: A pandas-compatible API for data exploration and transformation. | ||
| * **bigframes.ml**: A scikit-learn-like interface for BigQuery ML, including integration with Gemini. | ||
| * **bigframes.bigquery**: Specialized functions for managing BigQuery resources and deploying custom logic. | ||
|
|
||
| Why BigQuery DataFrames? | ||
| ------------------------ | ||
|
|
||
| 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. | ||
|
|
||
| * **Scalability:** Work with datasets that exceed local memory limits without complex refactoring. | ||
| * **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. | ||
| * **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. | ||
| * **Security & Governance:** Keep your data within the BigQuery perimeter. Benefit from enterprise-grade security, auditing, and data governance throughout your entire Python workflow. | ||
| * **Familiarity:** Use ``read_gbq``, ``merge``, ``groupby``, and ``pivot_table`` just like you do in pandas. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Might be nice to make these into links. |
||
|
|
||
| Quickstart | ||
| ---------- | ||
|
|
||
| Install the library via pip: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| pip install --upgrade bigframes | ||
|
|
||
| Load and aggregate a public dataset in just a few lines: | ||
|
|
||
| .. code-block:: python | ||
|
|
||
| import bigframes.pandas as bpd | ||
|
|
||
| # Load data from BigQuery | ||
| df = bpd.read_gbq("bigquery-public-data.usa_names.usa_1910_2013") | ||
|
|
||
| # Perform familiar pandas operations at scale | ||
| top_names = ( | ||
| df.groupby("name") | ||
| .agg({"number": "sum"}) | ||
| .sort_values("number", ascending=False) | ||
| .head(10) | ||
| ) | ||
|
|
||
| print(top_names.to_pandas()) | ||
|
|
||
|
|
||
| User Guide | ||
| ---------- | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
|
|
||
| user_guide/index | ||
|
|
||
| API reference | ||
| ------------- | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| User Guide | ||
| ********** | ||
|
|
||
| .. include:: ../README.rst | ||
|
|
||
| .. toctree:: | ||
| :caption: Guides | ||
| :maxdepth: 1 | ||
|
|
||
| Getting Started <https://docs.cloud.google.com/bigquery/docs/dataframes-quickstart> | ||
| Cloud Docs User Guides <https://docs.cloud.google.com/bigquery/docs/bigquery-dataframes-introduction> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we pull in some of the content from my go/why-bigframes draft? One of the missing elements here is enabling collaboration.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, new revision has more content from your doc