docs: add sample for getting started with BQML by DevStephanie · Pull Request #141 · googleapis/python-bigquery-dataframes

DevStephanie · 2023-10-25T15:31:38Z

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
Ensure the tests and linter pass
Code coverage does not decrease (if any source code was changed)
Appropriate docs were updated (if necessary)

Fixes #<issue_number_goes_here> 🦕

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

…l_comments

snippet-bot · 2023-10-25T17:32:41Z

Here is the summary of changes.

You are about to add 1 region tag.

samples/snippets/bqml_getting_started_test.py:19, tag bigquery_dataframes_bqml_getting_started_tutorial

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

tswast · 2023-10-30T19:20:48Z

+    # When writing a DataFrame to a BigQuery table, include destinaton table
+    # and parameters, index defaults to "True".


This comment has nothing to do with BigQuery ML models. Please fix.

Note: The important thing here is that we're taking our trained model and writing it to a permanent location.

Agreed, corrected.

FYI: The comment is still talking about tables not models. I'll make a comment with a suggested edit.

tswast · 2023-11-03T19:12:46Z

@@ -0,0 +1,13 @@
+# Copyright 2023 Google LLC


We can remove this file for now. Let's do a separate PR for the K-Means tutorials.

This file still needs to be deleted.

…bigquery-dataframes into bqml_tutorial

tswast · 2023-11-17T16:25:20Z

+
+    # The model.fit() call above created a temporary model.
+    # Use the to_gbq() method to write to a permanent location.
+    model.to_gbq("bqml_tutorial.sample_model", replace=True)


FYI: We're getting

E google.api_core.exceptions.BadRequest: 400 Concurrent update on same model: bigframes-dev:bqml_tutorial.sample_model is not supported. Share your usecase with the BigQuery DataFrames team at the [https://bit.ly/bigframes-feedback](https://www.google.com/url?q=https://bit.ly/bigframes-feedback&sa=D) survey.

failure in our test suite: https://fusion2.corp.google.com/invocations/8a7513c8-e7c9-4b5b-82fe-9a83c176fbc1/targets/bigframes%2Fpresubmit%2Fe2e/log

I think we'll need a test fixture for this to create a temporary place for the model and clean it up when the test finishes.

Create a file called samples/snippets/conftest.py.

In the conftest.py file you create, add a fixture called random_model_id, similar to this one: https://github.com/googleapis/python-bigquery/blob/f804d639fe95bef5d083afe1246d756321128b05/samples/snippets/conftest.py#L101-L111 except it'll call delete_model(...) instead of delete_table(...).

You'll also need to add "prefixer" https://github.com/googleapis/python-bigquery/blob/f804d639fe95bef5d083afe1246d756321128b05/samples/snippets/conftest.py#L21 and bigquery_client fixture https://github.com/googleapis/python-bigquery/blob/f804d639fe95bef5d083afe1246d756321128b05/samples/snippets/conftest.py#L33-L36

Update your code sample to use the new random_model_id fixture.

Look how we do it in the remote functions test:

python-bigquery-dataframes/samples/snippets/remote_function.py

Lines 17 to 23 in 81125f9

your_gcp_project_id = project_id

# [START bigquery_dataframes_remote_function]

import bigframes.pandas as bpd

# Set BigQuery DataFrames options

bpd.options.bigquery.project = your_gcp_project_id

but instead you'll be setting your_model_id = random_model_id and calling

model.to_gbq( your_model_id, # "project.dataset.model_id" or "dataset.model_id" replace=True, )

tswast · 2023-12-12T19:08:49Z

+
+
+def test_bqml_getting_started():
+    # [START bigquery_getting_started_bqml_tutorial]


Let's use bigquery_dataframes_bqml_getting_started for our region tags.

Sounds great, will make edits now.

tswast · 2023-12-12T20:35:43Z

@@ -0,0 +1,25 @@
+Copyright (c) 2013-2022, GeoPandas developers.


Revert this

docs: add sample for getting started with BQML

c1573f0

DevStephanie assigned tswast Oct 25, 2023

DevStephanie requested a review from a team as a code owner October 25, 2023 15:31

DevStephanie requested review from a team, ashleyxuu and ohmayr October 25, 2023 15:31

product-auto-label bot added size: m Pull request size is medium. api: bigquery Issues related to the googleapis/python-bigquery-dataframes API. samples Issues that are directly related to samples. labels Oct 25, 2023

gcf-owl-bot bot and others added 2 commits October 25, 2023 15:33

🦉 Updates from OwlBot post-processor

0b69c57

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Creating clarifying comments

4e7d81c

tswast mentioned this pull request Oct 25, 2023

Bqml comments #142

Closed

4 tasks

Your Name added 2 commits October 25, 2023 12:29

Merging comments with this branch

7e2094f

Correcting comments, merging with first branch bqml_tutorial from bqm…

a22640b

…l_comments

gcf-owl-bot bot and others added 4 commits October 25, 2023 17:34

🦉 Updates from OwlBot post-processor

0fc8d09

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

corrections on comments

8751f50

Correcting code comments from BQ docs

a67068e

🦉 Updates from OwlBot post-processor

9ec139e

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

tswast suggested changes Oct 30, 2023

View reviewed changes

tswast reviewed Oct 30, 2023

View reviewed changes

Your Name added 2 commits November 1, 2023 12:16

Fixing code comments to reflect BQML documentation

ec651b1

Correcting comments to reflect BQML documentation

be95c76

DevStephanie requested a review from tswast November 3, 2023 17:26

tswast suggested changes Nov 3, 2023

View reviewed changes

Correcting code comments

fbbe32b

DevStephanie requested a review from tswast November 6, 2023 18:13

DevStephanie and others added 3 commits November 6, 2023 12:52

Merge branch 'main' into bqml_tutorial

d4591c8

Correcting documentation code

a2b7f2f

Correcting documentation errors

c899565

Your Name and others added 3 commits November 13, 2023 12:45

Merge branch 'bqml_tutorial' of https://github.com/googleapis/python-…

bcdc9e2

…bigquery-dataframes into bqml_tutorial

Correcting documentation comments

93f911d

Apply suggestions from code review

f3aee5d

tswast approved these changes Nov 16, 2023

View reviewed changes

Comment thread samples/snippets/bqml_getting_started_test.py Outdated

Comment thread samples/snippets/bqml_getting_started_test.py Outdated

tswast added 2 commits November 16, 2023 16:46

Apply suggestions from code review

1ac855d

Merge branch 'main' into bqml_tutorial

b25bb26

tswast added automerge Merge the pull request once unit tests and other checks pass. and removed automerge Merge the pull request once unit tests and other checks pass. labels Nov 16, 2023

tswast suggested changes Nov 17, 2023

View reviewed changes

Merge branch 'main' into bqml_tutorial

1f0910a

tswast approved these changes Dec 11, 2023

View reviewed changes

tswast suggested changes Dec 12, 2023

View reviewed changes

tswast mentioned this pull request Dec 12, 2023

docs: add a code sample for creating a kmeans model #267

Merged

4 tasks

Your Name added 3 commits December 12, 2023 14:32

Fixtures for temporary resources

5494f46

Merge remote-tracking branch 'origin' into bqml_tutorial

a47a777

Merge remote-tracking branch 'origin/bqml_tutorial' into bqml_tutorial

016e81c

DevStephanie requested a review from a team December 12, 2023 20:34

product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Dec 12, 2023

tswast reviewed Dec 12, 2023

View reviewed changes

Deleting files

7a04299

product-auto-label bot added size: m Pull request size is medium. and removed size: l Pull request size is large. labels Dec 12, 2023

tswast approved these changes Dec 12, 2023

View reviewed changes

Merge branch 'main' into bqml_tutorial

fbf2527

tswast added the automerge Merge the pull request once unit tests and other checks pass. label Dec 12, 2023

tswast merged commit fb14f54 into main Dec 12, 2023

tswast deleted the bqml_tutorial branch December 12, 2023 22:25

gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Dec 12, 2023

release-please bot mentioned this pull request Dec 12, 2023

chore(main): release 0.17.0 #269

Merged

		# When writing a DataFrame to a BigQuery table, include destinaton table
		# and parameters, index defaults to "True".

	your_gcp_project_id = project_id

	# [START bigquery_dataframes_remote_function]
	import bigframes.pandas as bpd

	# Set BigQuery DataFrames options
	bpd.options.bigquery.project = your_gcp_project_id



		def test_bqml_getting_started():
		# [START bigquery_getting_started_bqml_tutorial]

		@@ -0,0 +1,25 @@
		Copyright (c) 2013-2022, GeoPandas developers.

Conversation

DevStephanie commented Oct 25, 2023

Uh oh!

snippet-bot bot commented Oct 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

snippet-bot bot commented Oct 25, 2023 •

edited

Loading