feat(samples): adds samples for enhanced version of library #16

telpirion · 2020-11-18T23:16:59Z

This PR updates the following samples to use the enhanced client library:

All create_batch_prediction_job samples for video
All create_training_pipeline samples for image, text, video, and tabular
All predict samples for image, tabular, and text

This PR relies on the PR that contains the enhanced client library.

snippet-bot · 2020-11-18T23:17:27Z

Here is the summary of changes.

You added 16 region tags.

samples/create-batch-prediction-job-video-classification.js:27, tag aiplatform_create_batch_prediction_job_video_classification
samples/create-batch-prediction-job-video-object-tracking.js:27, tag aiplatform_create_batch_prediction_job_video_object_tracking
samples/create-training-pipeline-image-object-detection.js:26, tag aiplatform_create_training_pipeline_image_object_detection
samples/create-training-pipeline-tabular-classification.js:27, tag aiplatform_create_training_pipeline_tables_classification
samples/create-training-pipeline-tabular-regression.js:27, tag aiplatform_create_training_pipeline_tables_regression
samples/create-training-pipeline-text-classification.js:26, tag aiplatform_create_training_pipeline_text_classification
samples/create-training-pipeline-text-entity-extraction.js:26, tag aiplatform_create_training_pipeline_text_entity_extraction
samples/create-training-pipeline-text-sentiment-analysis.js:26, tag aiplatform_create_training_pipeline_text_sentiment_analysis
samples/create-training-pipeline-video-classification.js:26, tag aiplatform_create_training_pipeline_video_classification
samples/create-training-pipeline-video-object-tracking.js:26, tag aiplatform_create_training_pipeline_video_object_tracking
samples/predict-image-object-detection.js:20, tag aiplatform_predict_image_object_detection
samples/predict-tabular-classification.js:20, tag aiplatform_predict_tabular_classification_sample
samples/predict-tabular-regression.js:20, tag aiplatform_predict_tabular_regression_sample
samples/predict-text-classification.js:20, tag aiplatform_predict_text_classification
samples/predict-text-entity-extraction.js:20, tag aiplatform_predict_text_entity_extraction
samples/predict-text-sentiment-analysis.js:20, tag aiplatform_predict_text_entity_extraction

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

codecov · 2021-01-07T20:02:44Z

Codecov Report

Merging #16 (fb1ec49) into master (be5d384) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master      #16      +/-   ##
==========================================
+ Coverage   98.80%   98.82%   +0.01%     
==========================================
  Files          15       15              
  Lines       20493    20493              
  Branches      575      575              
==========================================
+ Hits        20249    20253       +4     
+ Misses        236      232       -4     
  Partials        8        8

Impacted Files	Coverage Δ
src/v1beta1/dataset_service_client.ts	`99.18% <0.00%> (+0.06%)`	⬆️
src/v1beta1/endpoint_service_client.ts	`99.05% <0.00%> (+0.08%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update be5d384...fb1ec49. Read the comment docs.

bcoe

A couple initial comments for you.

bcoe · 2021-01-09T02:07:18Z

.kokoro/presubmit/node12/samples-test.cfg

@@ -8,5 +8,5 @@ env_vars: {

 env_vars: {
  key: "SECRET_MANAGER_KEYS"
-  value: "nodejs-ai-platform-env"
+  value: "nodejs-ai-platform-env, ucaip_samples_secrets"


we'll need to add .kokoro/presubmit/node12/samples-test.cfg to excludes, in synth.py, so that it's not overwritten when the templates update nightly.

bcoe · 2021-01-09T02:07:36Z

samples/create-batch-prediction-job-video-classification.js

+    // Create batch prediction job request
+    const [response] = await jobServiceClient.createBatchPredictionJob(request);
+
+    console.log(`Create batch prediction job video classification response`);


Suggested change

console.log(`Create batch prediction job video classification response`);

console.log('Create batch prediction job video classification response');

This is a problem across all of these samples. I've addressed them in spots, where I've found them, but we need to root them all out.

I've logged issue #38 .

Actually, I think we can mark #38 as fixed with this PR. I've removed all of the console.log statements with the unneeded back ticks.

bcoe · 2021-01-09T02:09:00Z

samples/create-batch-prediction-job-video-classification.js

+
+    const modelParameters = modelParamsObj.toValue();
+
+    const inputConfig = {


there's enough setup here, that I would be tempted to add a couple comments that include links to the corresponding documentation.

bcoe · 2021-01-09T02:11:50Z

samples/create-batch-prediction-job-video-classification.js

+    }
+
+    const dedicatedResource = response.dedicatedResource;
+    console.log(`\tDedicated resources`);


There's a lot of logic here for the printing logic, I'd be tempted to see if I could abstract it a bit into a helper, that's also between the START/END blocks, something like:

function printDedicatedResource(dedicatedResource) { } function printCompletionStats () { } ...

If you moved these down to the bottom of the sample, I think you would draw better attention to the more important part of samples which is the calls to the API.

Removed. Earlier versions of the Python canonicals had more verbose responses printed out. Now they're much shorter.

…i-platform into encl-samples

bcoe

This looks pretty much ready to go to me, I think we'll want to address the await issue I brought up, as it will make the samples embed better on cloud site.

bcoe · 2021-01-13T18:57:33Z

samples/create-batch-prediction-job-video-classification.js

+    console.log(response);
+  }
+  // [END aiplatform_create_batch_prediction_job_video_classification]
+  await createBatchPredictionJobVideoClassification();


If we don't have the createBatchPredictionJobVideoClassification inside the snippet, we'll show example code that doesn't actually invoke to the customer, instead do:

createBatchPredictionJobVideoClassification();

Dropping the await.

And you can add this:

rocess.on('unhandledRejection', err => { console.error(err.message); process.exitCode = 1; });

Just above your invocation of main.

bcoe · 2021-01-13T18:58:08Z

samples/create-training-pipeline-text-sentiment-analysis.js

+    console.log(response);
+  }
+  // [END aiplatform_create_training_pipeline_text_sentiment_analysis]
+  await createTrainingPipelineTextSentimentAnalysis();


looks like we'll need to address the await issue across the samles.

bcoe · 2021-01-13T19:00:40Z

samples/create-batch-prediction-job-video-classification.js

+    console.log('Create batch prediction job video classification response');
+    console.log(`Name : ${response.name}`);
+    console.log('Raw response:');
+    console.log(response);


If this is an object with nested keys, you might want to do:

console.log(JSON.stringify(response, null, 2));

I like this approach a lot better than having a huge amount of logic for printing.

🤖 I have created a release \*beep\* \*boop\* --- ## [1.3.0](https://www.github.com/googleapis/nodejs-ai-platform/compare/v1.2.0...v1.3.0) (2021-01-14) ### Features * **samples:** adds samples for enhanced version of library ([#16](https://www.github.com/googleapis/nodejs-ai-platform/issues/16)) ([aef443c](https://www.github.com/googleapis/nodejs-ai-platform/commit/aef443c41b8a9a2199e0c5b100a5ab91444b0dfe)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

telpirion added 4 commits November 18, 2020 12:33

feat: generates enhanced library via synthtool

ff70678

feat: adds methods to enhanced types

2b599bc

fix: lint

c3b8ec9

feat: adds enhanced library samples

3325360

product-auto-label bot added the cla: yes This human has signed the Contributor License Agreement. label Nov 18, 2020

google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Nov 18, 2020

telpirion added 2 commits January 7, 2021 11:49

Merge branch 'master' into encl-samples

ba6849f

fix: finishing merge

ff30eb5

telpirion added 15 commits January 7, 2021 12:32

fix: final merge conflict

c35a5b7

Merge branch 'master' into encl-samples

f469857

Merge branch 'master' into encl-samples

6b422e2

chore: add tests for samples

46d909b

fix: lint

5c9d4ec

fix: lint

4b94439

fix: lint

2a52217

fix: lint

0b35029

fix: changed cleanup for tests

2f5f18e

fix: changes batch prediction jobs to use API rather than samples

1350f5b

fix: broken return statement

24b1e14

fix: import jobServiceClient

76d0bc3

fix: attempt to fix tests

0c85285

fix: tests

95883fd

fix: lint

93ab9aa

bcoe suggested changes Jan 9, 2021

View reviewed changes

telpirion added 4 commits January 11, 2021 09:21

Merge branch 'master' into encl-samples

e216c89

fix: sample tests

367c084

Merge branch 'encl-samples' of https://github.com/googleapis/nodejs-a…

b3abd86

…i-platform into encl-samples

fix: tests

62037bb

telpirion added 9 commits January 11, 2021 13:35

fix: tests

a3190d3

fix: tests

7104596

fix: project ID in tests

006505f

fix: lint

573d02a

fix: sample tests

2eb0276

fix: tests and lint

d46eb72

fix: added quotes to text tests

f09d8de

fix: tabular classification test

91de4d8

Merge branch 'master' into encl-samples

5d0fd54

telpirion marked this pull request as ready for review January 12, 2021 19:42

telpirion requested review from a team as code owners January 12, 2021 19:42

telpirion added 2 commits January 12, 2021 12:37

fix: per reviewer

7df4ba4

Merge branch 'encl-samples' of https://github.com/googleapis/nodejs-a…

697a099

…i-platform into encl-samples

telpirion requested review from bcoe and lucaswadedavis January 12, 2021 20:39

bcoe suggested changes Jan 13, 2021

View reviewed changes

telpirion added 2 commits January 13, 2021 11:16

fix: per reviewer

a39db41

fix: per reviewer

a938114

telpirion requested a review from bcoe January 13, 2021 19:21

bcoe approved these changes Jan 13, 2021

View reviewed changes

bcoe changed the title ~~feat: adds samples for enhanced version of library~~ feat(samples): adds samples for enhanced version of library Jan 13, 2021

docs: update README

fb1ec49

bcoe merged commit aef443c into master Jan 13, 2021

bcoe deleted the encl-samples branch January 13, 2021 19:51

release-please bot mentioned this pull request May 18, 2022

chore(main): release 2.0.0 #305

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(samples): adds samples for enhanced version of library #16

feat(samples): adds samples for enhanced version of library #16

telpirion commented Nov 18, 2020

snippet-bot bot commented Nov 18, 2020 •

edited

Loading

codecov bot commented Jan 7, 2021 •

edited

Loading

bcoe left a comment

bcoe Jan 9, 2021

telpirion Jan 12, 2021

bcoe Jan 9, 2021

telpirion Jan 12, 2021

telpirion Jan 12, 2021

bcoe Jan 9, 2021

telpirion Jan 12, 2021

bcoe Jan 9, 2021

telpirion Jan 12, 2021

bcoe left a comment

bcoe Jan 13, 2021

telpirion Jan 13, 2021

bcoe Jan 13, 2021

telpirion Jan 13, 2021

bcoe Jan 13, 2021

telpirion Jan 13, 2021

	console.log(`Create batch prediction job video classification response`);
	console.log('Create batch prediction job video classification response');


		const modelParameters = modelParamsObj.toValue();

		const inputConfig = {

feat(samples): adds samples for enhanced version of library #16

feat(samples): adds samples for enhanced version of library #16

Conversation

telpirion commented Nov 18, 2020

snippet-bot bot commented Nov 18, 2020 • edited Loading

codecov bot commented Jan 7, 2021 • edited Loading

Codecov Report

bcoe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bcoe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

snippet-bot bot commented Nov 18, 2020 •

edited

Loading

codecov bot commented Jan 7, 2021 •

edited

Loading