docs: add base dataset samples for the automl ga (#290)

* Add base dataset samples for the AutoML GA * update package.json * Update License Headers, wait for storage delete operation to finish
GoogleCloudPlatform · Nov 17, 2022 · 72f02b7 · 72f02b7
1 parent 512edb7
commit 72f02b7
Show file tree

Hide file tree

Showing 16 changed files with 763 additions and 84 deletions.
diff --git a/automl/delete_dataset.js b/automl/delete_dataset.js
@@ -0,0 +1,53 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
+function main(
+  projectId = 'YOUR_PROJECT_ID',
+  location = 'us-central1',
+  datasetId = 'YOUR_DATASET_ID'
+) {
+  // [START automl_delete_dataset]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // const projectId = 'YOUR_PROJECT_ID';
+  // const location = 'us-central1';
+  // const datasetId = 'YOUR_DATASET_ID';
+
+  // Imports the Google Cloud AutoML library
+  const {AutoMlClient} = require(`@google-cloud/automl`).v1;
+
+  // Instantiates a client
+  const client = new AutoMlClient();
+
+  async function deleteDataset() {
+    // Construct request
+    const request = {
+      name: client.datasetPath(projectId, location, datasetId),
+    };
+
+    const [operation] = await client.deleteDataset(request);
+
+    // Wait for operation to complete.
+    const [response] = await operation.promise();
+    console.log(`Dataset deleted: ${response}`);
+  }
+
+  deleteDataset();
+  // [END automl_delete_dataset]
+}
+
+main(...process.argv.slice(2));
diff --git a/automl/export_dataset.js b/automl/export_dataset.js
@@ -0,0 +1,59 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
+function main(
+  projectId = 'YOUR_PROJECT_ID',
+  location = 'us-central1',
+  datasetId = 'YOUR_DATASET_ID',
+  gcsUri = 'gs://BUCKET_ID/path_to_export/'
+) {
+  // [START automl_export_dataset]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // const projectId = 'YOUR_PROJECT_ID';
+  // const location = 'us-central1';
+  // const datasetId = 'YOUR_DATASET_ID';
+  // const gcsUri = 'gs://BUCKET_ID/path_to_export/';
+
+  // Imports the Google Cloud AutoML library
+  const {AutoMlClient} = require(`@google-cloud/automl`).v1;
+
+  // Instantiates a client
+  const client = new AutoMlClient();
+
+  async function exportDataset() {
+    // Construct request
+    const request = {
+      name: client.datasetPath(projectId, location, datasetId),
+      outputConfig: {
+        gcsDestination: {
+          outputUriPrefix: gcsUri,
+        },
+      },
+    };
+
+    const [operation] = await client.exportData(request);
+    // Wait for operation to complete.
+    const [response] = await operation.promise();
+    console.log(`Dataset exported: ${response}`);
+  }
+
+  exportDataset();
+  // [END automl_export_dataset]
+}
+
+main(...process.argv.slice(2));
diff --git a/automl/get_dataset.js b/automl/get_dataset.js
@@ -0,0 +1,119 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
+function main(
+  projectId = 'YOUR_PROJECT_ID',
+  location = 'us-central1',
+  datasetId = 'YOUR_DATASET_ID'
+) {
+  // [START automl_language_entity_extraction_get_dataset]
+  // [START automl_language_sentiment_analysis_get_dataset]
+  // [START automl_language_text_classification_get_dataset]
+  // [START automl_translate_get_dataset]
+  // [START automl_vision_classification_get_dataset]
+  // [START automl_vision_object_detection_get_dataset]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // const projectId = 'YOUR_PROJECT_ID';
+  // const location = 'us-central1';
+  // const datasetId = 'YOUR_DATASET_ID';
+
+  // Imports the Google Cloud AutoML library
+  const {AutoMlClient} = require(`@google-cloud/automl`).v1;
+
+  // Instantiates a client
+  const client = new AutoMlClient();
+
+  async function getDataset() {
+    // Construct request
+    const request = {
+      name: client.datasetPath(projectId, location, datasetId),
+    };
+
+    const [response] = await client.getDataset(request);
+
+    console.log(`Dataset name: ${response.name}`);
+    console.log(
+      `Dataset id: ${
+        response.name.split('/')[response.name.split('/').length - 1]
+      }`
+    );
+    console.log(`Dataset display name: ${response.displayName}`);
+    console.log(`Dataset create time`);
+    console.log(`\tseconds ${response.createTime.seconds}`);
+    console.log(`\tnanos ${response.createTime.nanos / 1e9}`);
+    // [END automl_language_sentiment_analysis_get_dataset]
+    // [END automl_language_text_classification_get_dataset]
+    // [END automl_translate_get_dataset]
+    // [END automl_vision_classification_get_dataset]
+    // [END automl_vision_object_detection_get_dataset]
+    console.log(
+      `Text extraction dataset metadata: ${response.textExtractionDatasetMetadata}`
+    );
+    // [END automl_language_entity_extraction_get_dataset]
+
+    // [START automl_language_sentiment_analysis_get_dataset]
+    console.log(
+      `Text sentiment dataset metadata: ${response.textSentimentDatasetMetadata}`
+    );
+    // [END automl_language_sentiment_analysis_get_dataset]
+
+    // [START automl_language_text_classification_get_dataset]
+    console.log(
+      `Text classification dataset metadata: ${response.textClassificationDatasetMetadata}`
+    );
+    // [END automl_language_text_classification_get_dataset]
+
+    // [START automl_translate_get_dataset]
+    if (response.translationDatasetMetadata !== undefined) {
+      console.log(`Translation dataset metadata:`);
+      console.log(
+        `\tSource language code: ${response.translationDatasetMetadata.sourceLanguageCode}`
+      );
+      console.log(
+        `\tTarget language code: ${response.translationDatasetMetadata.targetLanguageCode}`
+      );
+    }
+    // [END automl_translate_get_dataset]
+
+    // [START automl_vision_classification_get_dataset]
+    console.log(
+      `Image classification dataset metadata: ${response.imageClassificationDatasetMetadata}`
+    );
+    // [END automl_vision_classification_get_dataset]
+
+    // [START automl_vision_object_detection_get_dataset]
+    console.log(
+      `Image object detection dataset metatdata: ${response.imageObjectDetectionDatasetMetatdata}`
+    );
+    // [START automl_language_entity_extraction_get_dataset]
+    // [START automl_language_sentiment_analysis_get_dataset]
+    // [START automl_language_text_classification_get_dataset]
+    // [START automl_translate_get_dataset]
+    // [START automl_vision_classification_get_dataset]
+  }
+
+  getDataset();
+  // [END automl_language_entity_extraction_get_dataset]
+  // [END automl_language_sentiment_analysis_get_dataset]
+  // [END automl_language_text_classification_get_dataset]
+  // [END automl_translate_get_dataset]
+  // [END automl_vision_classification_get_dataset]
+  // [END automl_vision_object_detection_get_dataset]
+}
+
+main(...process.argv.slice(2));
diff --git a/automl/import_dataset.js b/automl/import_dataset.js
@@ -0,0 +1,62 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
+function main(
+  projectId = 'YOUR_PROJECT_ID',
+  location = 'us-central1',
+  datasetId = 'YOUR_DISPLAY_ID',
+  path = 'gs://BUCKET_ID/path_to_training_data.csv'
+) {
+  // [START automl_import_dataset]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // const projectId = 'YOUR_PROJECT_ID';
+  // const location = 'us-central1';
+  // const datasetId = 'YOUR_DISPLAY_ID';
+  // const path = 'gs://BUCKET_ID/path_to_training_data.csv';
+
+  // Imports the Google Cloud AutoML library
+  const {AutoMlClient} = require(`@google-cloud/automl`).v1;
+
+  // Instantiates a client
+  const client = new AutoMlClient();
+
+  async function importDataset() {
+    // Construct request
+    const request = {
+      name: client.datasetPath(projectId, location, datasetId),
+      inputConfig: {
+        gcsSource: {
+          inputUris: path.split(','),
+        },
+      },
+    };
+
+    // Import dataset
+    console.log(`Proccessing import`);
+    const [operation] = await client.importData(request);
+
+    // Wait for operation to complete.
+    const [response] = await operation.promise();
+    console.log(`Dataset imported: ${response}`);
+  }
+
+  importDataset();
+  // [END automl_import_dataset]
+}
+
+main(...process.argv.slice(2));
diff --git a/automl/language_entity_extraction_create_dataset.js b/automl/language_entity_extraction_create_dataset.js
@@ -1,17 +1,16 @@
-/**
- * Copyright 2019 Google LLC
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
 'use strict';
 

diff --git a/automl/language_entity_extraction_create_model.js b/automl/language_entity_extraction_create_model.js
@@ -1,17 +1,16 @@
-/**
- * Copyright 2019 Google LLC
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
 'use strict';
 

diff --git a/automl/language_entity_extraction_predict.js b/automl/language_entity_extraction_predict.js
@@ -1,17 +1,16 @@
-/**
- * Copyright 2019 Google LLC
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
 'use strict';