docs: Added eval_id comments to node.js samples (#236)

nayaknishant · web-flow · commit 43108265a0ab · 2021-12-02T14:04:24.000-08:00
diff --git a/ai-platform/snippets/get-model-evaluation-image-classification.js b/ai-platform/snippets/get-model-evaluation-image-classification.js
@@ -19,9 +19,16 @@
 async function main(modelId, evaluationId, project, location = 'us-central1') {
   // [START aiplatform_get_model_evaluation_image_classification]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.\
-   * (Not necessary if passing values as arguments)
+   * TODO(developer): Uncomment these variables before running the sample
+   * (not necessary if passing values as arguments). To obtain evaluationId,
+   * instantiate the client and run the following the commands.
    */
+  // const parentName = `projects/${project}/locations/${location}/models/${modelId}`;
+  // const evalRequest = {
+  //   parent: parentName
+  // };
+  // const [evalResponse] = await modelServiceClient.listModelEvaluations(evalRequest);
+  // console.log(evalResponse);
 
   // const modelId = 'YOUR_MODEL_ID';
   // const evaluationId = 'YOUR_EVALUATION_ID';
diff --git a/ai-platform/snippets/get-model-evaluation-image-object-detection.js b/ai-platform/snippets/get-model-evaluation-image-object-detection.js
@@ -19,8 +19,16 @@
 async function main(modelId, evaluationId, project, location = 'us-central1') {
   // [START aiplatform_get_model_evaluation_image_object_detection]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.\
+   * TODO(developer): Uncomment these variables before running the sample
+   * (not necessary if passing values as arguments). To obtain evaluationId,
+   * instantiate the client and run the following the commands.
    */
+  // const parentName = `projects/${project}/locations/${location}/models/${modelId}`;
+  // const evalRequest = {
+  //   parent: parentName
+  // };
+  // const [evalResponse] = await modelServiceClient.listModelEvaluations(evalRequest);
+  // console.log(evalResponse);
 
   // const modelId = 'YOUR_MODEL_ID';
   // const evaluationId = 'YOUR_EVALUATION_ID';
diff --git a/ai-platform/snippets/get-model-evaluation-slice.js b/ai-platform/snippets/get-model-evaluation-slice.js
@@ -25,9 +25,16 @@ async function main(
 ) {
   // [START aiplatform_get_model_evaluation_slice]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.\
-     (Not necessary if passing values as arguments)
+   * TODO(developer): Uncomment these variables before running the sample
+   * (not necessary if passing values as arguments). To obtain evaluationId,
+   * instantiate the client and run the following the commands.
    */
+  // const parentName = `projects/${project}/locations/${location}/models/${modelId}`;
+  // const evalRequest = {
+  //   parent: parentName
+  // };
+  // const [evalResponse] = await modelServiceClient.listModelEvaluations(evalRequest);
+  // console.log(evalResponse);
 
   // const modelId = 'YOUR_MODEL_ID';
   // const evaluationId = 'YOUR_EVALUATION_ID';
diff --git a/ai-platform/snippets/get-model-evaluation-tabular-classification.js b/ai-platform/snippets/get-model-evaluation-tabular-classification.js
@@ -19,8 +19,16 @@
 async function main(modelId, evaluationId, project, location = 'us-central1') {
   // [START aiplatform_get_model_evaluation_tabular_classification]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.\
+   * TODO(developer): Uncomment these variables before running the sample
+   * (not necessary if passing values as arguments). To obtain evaluationId,
+   * instantiate the client and run the following the commands.
    */
+  // const parentName = `projects/${project}/locations/${location}/models/${modelId}`;
+  // const evalRequest = {
+  //   parent: parentName
+  // };
+  // const [evalResponse] = await modelServiceClient.listModelEvaluations(evalRequest);
+  // console.log(evalResponse);
 
   // const modelId = 'YOUR_MODEL_ID';
   // const evaluationId = 'YOUR_EVALUATION_ID';
diff --git a/ai-platform/snippets/get-model-evaluation-tabular-regression.js b/ai-platform/snippets/get-model-evaluation-tabular-regression.js
@@ -19,9 +19,16 @@
 async function main(modelId, evaluationId, project, location = 'us-central1') {
   // [START aiplatform_get_model_evaluation_tabular_regression]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.\
-   * (Not necessary if passing values as arguments)
+   * TODO(developer): Uncomment these variables before running the sample
+   * (not necessary if passing values as arguments). To obtain evaluationId,
+   * instantiate the client and run the following the commands.
    */
+  // const parentName = `projects/${project}/locations/${location}/models/${modelId}`;
+  // const evalRequest = {
+  //   parent: parentName
+  // };
+  // const [evalResponse] = await modelServiceClient.listModelEvaluations(evalRequest);
+  // console.log(evalResponse);
 
   // const modelId = 'YOUR_MODEL_ID';
   // const evaluationId = 'YOUR_EVALUATION_ID';
diff --git a/ai-platform/snippets/get-model-evaluation-text-classification.js b/ai-platform/snippets/get-model-evaluation-text-classification.js
@@ -19,9 +19,16 @@
 async function main(modelId, evaluationId, project, location = 'us-central1') {
   // [START aiplatform_get_model_evaluation_text_classification]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.\
-   * (Not necessary if passing values as arguments)
+   * TODO(developer): Uncomment these variables before running the sample
+   * (not necessary if passing values as arguments). To obtain evaluationId,
+   * instantiate the client and run the following the commands.
    */
+  // const parentName = `projects/${project}/locations/${location}/models/${modelId}`;
+  // const evalRequest = {
+  //   parent: parentName
+  // };
+  // const [evalResponse] = await modelServiceClient.listModelEvaluations(evalRequest);
+  // console.log(evalResponse);
 
   // const modelId = 'YOUR_MODEL_ID';
   // const evaluationId = 'YOUR_EVALUATION_ID';
diff --git a/ai-platform/snippets/get-model-evaluation-text-entity-extraction.js b/ai-platform/snippets/get-model-evaluation-text-entity-extraction.js
@@ -19,9 +19,16 @@
 async function main(modelId, evaluationId, project, location = 'us-central1') {
   // [START aiplatform_get_model_evaluation_text_entity_extraction]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.\
-   * (Not necessary if passing values as arguments)
+   * TODO(developer): Uncomment these variables before running the sample
+   * (not necessary if passing values as arguments). To obtain evaluationId,
+   * instantiate the client and run the following the commands.
    */
+  // const parentName = `projects/${project}/locations/${location}/models/${modelId}`;
+  // const evalRequest = {
+  //   parent: parentName
+  // };
+  // const [evalResponse] = await modelServiceClient.listModelEvaluations(evalRequest);
+  // console.log(evalResponse);
 
   // const modelId = 'YOUR_MODEL_ID';
   // const evaluationId = 'YOUR_EVALUATION_ID';
diff --git a/ai-platform/snippets/get-model-evaluation-text-sentiment-analysis.js b/ai-platform/snippets/get-model-evaluation-text-sentiment-analysis.js
@@ -19,9 +19,16 @@
 async function main(modelId, evaluationId, project, location = 'us-central1') {
   // [START aiplatform_get_model_evaluation_text_sentiment_analysis]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.\
-   * (Not necessary if passing values as arguments)
+   * TODO(developer): Uncomment these variables before running the sample
+   * (not necessary if passing values as arguments). To obtain evaluationId,
+   * instantiate the client and run the following the commands.
    */
+  // const parentName = `projects/${project}/locations/${location}/models/${modelId}`;
+  // const evalRequest = {
+  //   parent: parentName
+  // };
+  // const [evalResponse] = await modelServiceClient.listModelEvaluations(evalRequest);
+  // console.log(evalResponse);
 
   // const modelId = 'YOUR_MODEL_ID';
   // const evaluationId = 'YOUR_EVALUATION_ID';
diff --git a/ai-platform/snippets/get-model-evaluation-video-action-recognition.js b/ai-platform/snippets/get-model-evaluation-video-action-recognition.js
@@ -19,9 +19,16 @@
 async function main(modelId, evaluationId, project, location = 'us-central1') {
   // [START aiplatform_get_model_evaluation_video_action_recognition]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.\
-   * (Not necessary if passing values as arguments)
+   * TODO(developer): Uncomment these variables before running the sample
+   * (not necessary if passing values as arguments). To obtain evaluationId,
+   * instantiate the client and run the following the commands.
    */
+  // const parentName = `projects/${project}/locations/${location}/models/${modelId}`;
+  // const evalRequest = {
+  //   parent: parentName
+  // };
+  // const [evalResponse] = await modelServiceClient.listModelEvaluations(evalRequest);
+  // console.log(evalResponse);
 
   // const modelId = 'YOUR_MODEL_ID';
   // const evaluationId = 'YOUR_EVALUATION_ID';
diff --git a/ai-platform/snippets/get-model-evaluation-video-classification.js b/ai-platform/snippets/get-model-evaluation-video-classification.js
@@ -19,9 +19,16 @@
 async function main(modelId, evaluationId, project, location = 'us-central1') {
   // [START aiplatform_get_model_evaluation_video_classification]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.\
-   * (Not necessary if passing values as arguments)
+   * TODO(developer): Uncomment these variables before running the sample
+   * (not necessary if passing values as arguments). To obtain evaluationId,
+   * instantiate the client and run the following the commands.
    */
+  // const parentName = `projects/${project}/locations/${location}/models/${modelId}`;
+  // const evalRequest = {
+  //   parent: parentName
+  // };
+  // const [evalResponse] = await modelServiceClient.listModelEvaluations(evalRequest);
+  // console.log(evalResponse);
 
   // const modelId = 'YOUR_MODEL_ID';
   // const evaluationId = 'YOUR_EVALUATION_ID';
diff --git a/ai-platform/snippets/get-model-evaluation-video-object-tracking.js b/ai-platform/snippets/get-model-evaluation-video-object-tracking.js
@@ -19,9 +19,16 @@
 async function main(modelId, evaluationId, project, location = 'us-central1') {
   // [START aiplatform_get_model_evaluation_video_object_tracking]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.\
-   * (Not necessary if passing values as arguments)
+   * TODO(developer): Uncomment these variables before running the sample
+   * (not necessary if passing values as arguments). To obtain evaluationId,
+   * instantiate the client and run the following the commands.
    */
+  // const parentName = `projects/${project}/locations/${location}/models/${modelId}`;
+  // const evalRequest = {
+  //   parent: parentName
+  // };
+  // const [evalResponse] = await modelServiceClient.listModelEvaluations(evalRequest);
+  // console.log(evalResponse);
 
   // const modelId = 'YOUR_MODEL_ID';
   // const evaluationId = 'YOUR_EVALUATION_ID';
diff --git a/ai-platform/snippets/list-model-evaluation-slices.js b/ai-platform/snippets/list-model-evaluation-slices.js
@@ -19,9 +19,16 @@
 async function main(modelId, evaluationId, project, location = 'us-central1') {
   // [START aiplatform_list_model_evaluation_slices]
   /**
-   * TODO(developer): Uncomment these variables before running the sample.\
-   * (Not necessary if passing values as arguments)
+   * TODO(developer): Uncomment these variables before running the sample
+   * (not necessary if passing values as arguments). To obtain evaluationId,
+   * instantiate the client and run the following the commands.
    */
+  // const parentName = `projects/${project}/locations/${location}/models/${modelId}`;
+  // const evalRequest = {
+  //   parent: parentName
+  // };
+  // const [evalResponse] = await modelServiceClient.listModelEvaluations(evalRequest);
+  // console.log(evalResponse);
 
   // const modelId = 'YOUR_MODEL_ID';
   // const evaluationId = 'YOUR_EVALUATION_ID';
