docs: add a code sample for creating a kmeans model by SalemJorden · Pull Request #267 · googleapis/python-bigquery-dataframes

SalemJorden · 2023-12-11T20:46:35Z

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

samples/snippets/create_kmeans_model_test.py

snippet-bot · 2023-12-12T20:31:40Z

Here is the summary of changes.

You are about to add 3 region tags.

samples/snippets/create_kmeans_model_test.py:18, tag bigquery_dataframes_bqml_kmeans
samples/snippets/create_kmeans_model_test.py:108, tag bigquery_dataframes_bqml_kmeans_fit
samples/snippets/create_kmeans_model_test.py:121, tag bigquery_dataframes_bqml_kmeans_predict

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

Co-authored-by: Tim Swast <swast@google.com>

samples/snippets/create_kmeans_model_test.py

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

samples/snippets/create_kmeans_model_test.py

Co-authored-by: Tim Swast <swast@google.com>

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

samples/snippets/create_kmeans_model_test.py

tswast

Looking good, but a few comments regarding the comments.

samples/snippets/create_kmeans_model_test.py

tswast · 2024-02-05T22:51:38Z

samples/snippets/create_kmeans_model_test.py

+    # value.
+    cluster_model = KMeans(n_clusters=4)
+    cluster_model.fit(stationstats)
+


Let's do a to_gbq() here to save the model to a permanent location.

It should look very similar to the getting started tutorial:

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

Lines 87 to 92 in 93835ef

# The model.fit() call above created a temporary model.

# Use the to_gbq() method to write to a permanent location.

model.to_gbq(

your_model_id, # For example: "bqml_tutorial.sample_model",

replace=True,

)

Added to_gbq() to save the model.

samples/snippets/create_kmeans_model_test.py

Co-authored-by: Tim Swast <swast@google.com>

samples/snippets/conftest.py

tswast · 2024-02-07T20:26:52Z

samples/snippets/create_kmeans_model_test.py

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


It's 2024 now. These headers should reflect when the text was first written.

Suggested change

# Copyright 2023 Google LLC

# Copyright 2024 Google LLC

tswast · 2024-02-07T20:30:05Z

samples/snippets/create_kmeans_model_test.py

+    cluster_model = KMeans(n_clusters=4)
+    cluster_model.fit(stationstats)
+    cluster_model.to_gbq(
+        your_gcp_project_id,  # For example: "bqml_tutorial.sample_model"


Project ID isn't sufficient. We want a model ID.

tswast · 2024-02-07T20:30:28Z

samples/snippets/create_kmeans_model_test.py

+    # from BigQuery, but you could also use the `cluster_model` object from
+    # previous steps.
+    cluster_model = bpd.read_gbq_model(
+        your_gcp_project_id,


Not project ID. This should be the same model ID as the one we use in to_gbq above (once you change that).

…-dataframes into Salem

tswast

LGTM, but let's wait for e2e tests to pass before merging.

tswast · 2024-02-26T16:05:00Z

samples/snippets/create_kmeans_model_test.py

+# limitations under the License.
+
+
+def test_kmeans_sample(project_id: str, random_model_id: str):


The test failure on samples/snippets/create_kmeans_model_test.py is a real one. We need to create a random_model_id_eu fixture.

> raise exceptions.from_http_response(response) E google.api_core.exceptions.NotFound: 404 POST [https://bigquery.googleapis.com/bigquery/v2/projects/bigframes-load-testing/jobs?prettyPrint=false](https://www.google.com/url?q=https://bigquery.googleapis.com/bigquery/v2/projects/bigframes-load-testing/jobs?prettyPrint%3Dfalse&sa=D): Not found: Dataset bigframes-load-testing:python_bigquery_dataframes_samples_snippets_20240223223225_52ccfc was not found in location EU E E Location: EU E Job ID: 3a8974a6-1007-483a-97f0-2e9c267f17e4 [.nox/samples-3-9/lib/python3.9/site-packages/google/cloud/_http/__init__.py:494](https://cs.corp.google.com/piper///depot/google3/.nox/samples-3-9/lib/python3.9/site-packages/google/cloud/_http/__init__.py?l=494): NotFound

samples/snippets/conftest.py

tswast

Love it! Thanks for your work on this.

Salem Boyland added 4 commits December 6, 2023 12:12

k-means code sample

69fe5d7

formatting

5fb1d4f

added test

523255f

docs: add code sampke for creating kmeans model

3bb267a

SalemJorden requested a review from tswast December 11, 2023 20:46

SalemJorden requested review from a team as code owners December 11, 2023 20:46

SalemJorden requested a review from parthea December 11, 2023 20:46

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 Dec 11, 2023

🦉 Updates from OwlBot post-processor

73d2a46

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

tswast requested changes Dec 12, 2023

View reviewed changes

Salem Boyland added 2 commits December 12, 2023 14:24

license header + region tags added

b3c0578

Resolved conflicts

c25aeb5

SalemJorden and others added 3 commits December 12, 2023 14:55

Update samples/snippets/create_kmeans_model_test.py

db9f439

Co-authored-by: Tim Swast <swast@google.com>

code corrections resolved

e7bd5ef

resolved merge conflicts

2a7d575

tswast requested changes Dec 13, 2023

View reviewed changes

tswast mentioned this pull request Dec 14, 2023

Create a k-means model to cluster London bicycle hires dataset googleapis/python-bigquery#1744

Closed

4 tasks

Salem Boyland and others added 4 commits December 18, 2023 14:32

code corrections commit 1

809ed05

descriptions of geospatial analysis functions

5dba2b9

explantions revised for clarity

2207941

🦉 Updates from OwlBot post-processor

5e00a3c

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

tswast requested changes Dec 19, 2023

View reviewed changes

SalemJorden and others added 4 commits December 19, 2023 12:44

Update samples/snippets/create_kmeans_model_test.py

7c64227

Co-authored-by: Tim Swast <swast@google.com>

code corrections

11678e0

code revision

f95cd9f

code changes

0df2dec

Salem Boyland and others added 3 commits December 26, 2023 13:54

tests passing, expected output characters >80

019e243

🦉 Updates from OwlBot post-processor

72174f9

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

Merge branch 'main' into Salem

50a447d

tswast requested changes Dec 26, 2023

View reviewed changes

Salem Boyland added 2 commits December 27, 2023 12:07

column wrapping

ac348bf

merge

7ce5337

googleapis locked as resolved and limited conversation to collaborators Jan 3, 2024

SalemJorden added 3 commits January 30, 2024 12:57

Merge branch 'main' into Salem

29b2e1f

Merge branch 'main' into Salem

7762f0f

Merge branch 'main' into Salem

479a828

SalemJorden requested a review from tswast February 5, 2024 15:59

reset session before running code smaples

1572ddd

tswast requested changes Feb 5, 2024

View reviewed changes

SalemJorden and others added 2 commits February 6, 2024 14:09

Update samples/snippets/create_kmeans_model_test.py

3d77ddd

Co-authored-by: Tim Swast <swast@google.com>

predict function added to tutorial

505b790

tswast requested changes Feb 7, 2024

View reviewed changes

SalemJorden added 4 commits February 9, 2024 15:22

replaced project_id with model_id

4505c5c

Merge branch 'main' into Salem

cad2185

reformatting

3ab8220

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

816881c

…-dataframes into Salem

tswast approved these changes Feb 23, 2024

View reviewed changes

Merge branch 'main' into Salem

9b382d6

tswast requested changes Feb 26, 2024

View reviewed changes

reformat

ae9a362

tswast approved these changes Feb 27, 2024

View reviewed changes

Merge branch 'main' into Salem

5eb59ec

tswast added the automerge Merge the pull request once unit tests and other checks pass. label Feb 27, 2024

tswast merged commit 4291d65 into main Feb 27, 2024

tswast deleted the Salem branch February 27, 2024 21:14

gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Feb 27, 2024

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

		# limitations under the License.


		def test_kmeans_sample(project_id: str, random_model_id: str):

Conversation

SalemJorden commented Dec 11, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

snippet-bot bot commented Dec 12, 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tswast left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tswast Feb 5, 2024

Choose a reason for hiding this comment

Uh oh!

SalemJorden Feb 7, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

tswast Feb 7, 2024

Choose a reason for hiding this comment

Uh oh!

tswast Feb 7, 2024

Choose a reason for hiding this comment

Uh oh!

tswast Feb 7, 2024

Choose a reason for hiding this comment

Uh oh!

tswast left a comment

Choose a reason for hiding this comment

Uh oh!

tswast Feb 26, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tswast left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

snippet-bot bot commented Dec 12, 2023 •

edited

Loading