Class: Google::Cloud::AIPlatform::V1::Model

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/model.rb

Overview

A trained machine learning Model.

Defined Under Namespace

Modules: DeploymentResourcesType Classes: BaseModelSource, DataStats, ExportFormat, LabelsEntry, OriginalModelInfo

Instance Attribute Summary collapse

Instance Attribute Details

#artifact_uri ⇒ ::String

Returns Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.

Returns:

  • (::String) —

    Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#base_model_source ⇒ ::Google::Cloud::AIPlatform::V1::Model::BaseModelSource

Returns Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#container_spec ⇒ ::Google::Cloud::AIPlatform::V1::ModelContainerSpec

Returns Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this Model was uploaded into Vertex AI.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#data_stats ⇒ ::Google::Cloud::AIPlatform::V1::Model::DataStats

Returns Stats of data used for training or evaluating the Model.

Only populated when the Model is trained by a TrainingPipeline with [data_input_config][TrainingPipeline.data_input_config].

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#deployed_models ⇒ ::Array<::Google::Cloud::AIPlatform::V1::DeployedModelRef> (readonly)

Returns Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#description ⇒ ::String

Returns The description of the Model.

Returns:

  • (::String) —

    The description of the Model.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#display_name ⇒ ::String

Returns Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns:

  • (::String) —

    Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#encryption_spec ⇒ ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns Customer-managed encryption key spec for a Model. If set, this Model and all sub-resources of this Model will be secured by this key.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#etag ⇒ ::String

Returns Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns:

  • (::String) —

    Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#explanation_spec ⇒ ::Google::Cloud::AIPlatform::V1::ExplanationSpec

Returns The default explanation specification for this Model.

The Model can be used for [requesting explanation][google.cloud.aiplatform.v1.PredictionService.Explain] after being deployed if it is populated. The Model can be used for [batch explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] if it is populated.

All fields of the explanation_spec can be overridden by explanation_spec of DeployModelRequest.deployed_model, or explanation_spec of BatchPredictionJob.

If the default explanation specification is not set for this Model, this Model can still be used for [requesting explanation][google.cloud.aiplatform.v1.PredictionService.Explain] by setting explanation_spec of DeployModelRequest.deployed_model and for [batch explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] by setting explanation_spec of BatchPredictionJob.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns The labels with user-defined metadata to organize your Models.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    The labels with user-defined metadata to organize your Models.

    Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

    See https://goo.gl/xmQnxf for more information and examples of labels.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#metadata ⇒ ::Google::Protobuf::Value

Returns Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.

Returns:

  • (::Google::Protobuf::Value) —

    Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#metadata_artifact ⇒ ::String (readonly)

Returns Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}.

Returns:

  • (::String) —

    Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#metadata_schema_uri ⇒ ::String

Returns Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

Returns:

  • (::String) —

    Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#model_source_info ⇒ ::Google::Cloud::AIPlatform::V1::ModelSourceInfo (readonly)

Returns Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#name ⇒ ::String

Returns The resource name of the Model.

Returns:

  • (::String) —

    The resource name of the Model.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#original_model_info ⇒ ::Google::Cloud::AIPlatform::V1::Model::OriginalModelInfo (readonly)

Returns Output only. If this Model is a copy of another Model, this contains info about the original.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#pipeline_job ⇒ ::String

Returns Optional. This field is populated if the model is produced by a pipeline job.

Returns:

  • (::String) —

    Optional. This field is populated if the model is produced by a pipeline job.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#predict_schemata ⇒ ::Google::Cloud::AIPlatform::V1::PredictSchemata

Returns The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#supported_deployment_resources_types ⇒ ::Array<::Google::Cloud::AIPlatform::V1::Model::DeploymentResourcesType> (readonly)

Returns Output only. When this Model is deployed, its prediction resources are described by the prediction_resources field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#supported_export_formats ⇒ ::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat> (readonly)

Returns Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#supported_input_storage_formats ⇒ ::Array<::String> (readonly)

Returns Output only. The formats this Model supports in BatchPredictionJob.input_config. If PredictSchemata.instance_schema_uri exists, the instances should be given as per that schema.

The possible formats are:

  • jsonl The JSON Lines format, where each instance is a single line. Uses GcsSource.

  • csv The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsSource.

  • tf-record The TFRecord format, where each instance is a single record in tfrecord syntax. Uses GcsSource.

  • tf-record-gzip Similar to tf-record, but the file is gzipped. Uses GcsSource.

  • bigquery Each instance is a single row in BigQuery. Uses BigQuerySource.

  • file-list Each line of the file is the location of an instance to process, uses gcs_source field of the InputConfig object.

If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#supported_output_storage_formats ⇒ ::Array<::String> (readonly)

Returns Output only. The formats this Model supports in BatchPredictionJob.output_config. If both PredictSchemata.instance_schema_uri and PredictSchemata.prediction_schema_uri exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema).

The possible formats are:

  • jsonl The JSON Lines format, where each prediction is a single line. Uses GcsDestination.

  • csv The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses GcsDestination.

  • bigquery Each prediction is a single row in a BigQuery table, uses BigQueryDestination .

If this Model doesn't support any of these formats it means it cannot be used with a BatchPredictionJob. However, if it has supported_deployment_resources_types, it could serve online predictions by using PredictionService.Predict or PredictionService.Explain.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#training_pipeline ⇒ ::String (readonly)

Returns Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.

Returns:

  • (::String) —

    Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this Model was most recently updated.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#version_aliases ⇒ ::Array<::String>

Returns User provided version aliases so that a model version can be referenced via alias (i.e. projects/{project}/locations/{location}/models/{model_id}@{version_alias} instead of auto-generated version id (i.e. projects/{project}/locations/{location}/models/{model_id}@{version_id}). The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model.

Returns:

  • (::Array<::String>) —

    User provided version aliases so that a model version can be referenced via alias (i.e. projects/{project}/locations/{location}/models/{model_id}@{version_alias} instead of auto-generated version id (i.e. projects/{project}/locations/{location}/models/{model_id}@{version_id}). The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from version_id. A default version alias will be created for the first version of the model, and there must be exactly one default version alias for a model.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#version_create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this version was created.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#version_description ⇒ ::String

Returns The description of this version.

Returns:

  • (::String) —

    The description of this version.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#version_id ⇒ ::String (readonly)

Returns Output only. Immutable. The version ID of the model. A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation.

Returns:

  • (::String) —

    Output only. Immutable. The version ID of the model. A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end

#version_update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this version was most recently updated.

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 308

class Model
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents export format supported by the Model.
  # All formats export to Google Cloud Storage.
  # @!attribute [r] id
  #   @return [::String]
  #     Output only. The ID of the export format.
  #     The possible format IDs are:
  #
  #     * `tflite`
  #     Used for Android mobile devices.
  #
  #     * `edgetpu-tflite`
  #     Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices.
  #
  #     * `tf-saved-model`
  #     A tensorflow model in SavedModel format.
  #
  #     * `tf-js`
  #     A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used
  #     in the browser and in Node.js using JavaScript.
  #
  #     * `core-ml`
  #     Used for iOS mobile devices.
  #
  #     * `custom-trained`
  #     A Model that was uploaded or trained by custom code.
  # @!attribute [r] exportable_contents
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Model::ExportFormat::ExportableContent>]
  #     Output only. The content of this Model that may be exported.
  class ExportFormat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The Model content that can be exported.
    module ExportableContent
      # Should not be used.
      EXPORTABLE_CONTENT_UNSPECIFIED = 0

      # Model artifact and any of its supported files. Will be exported to the
      # location specified by the `artifactDestination` field of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      ARTIFACT = 1

      # The container image that is to be used when deploying this Model. Will
      # be exported to the location specified by the `imageDestination` field
      # of the
      # {::Google::Cloud::AIPlatform::V1::ExportModelRequest#output_config ExportModelRequest.output_config}
      # object.
      IMAGE = 2
    end
  end

  # Stats of data used for train or evaluate the Model.
  # @!attribute [rw] training_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for training this Model.
  # @!attribute [rw] validation_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for validating this Model during
  #     training.
  # @!attribute [rw] test_data_items_count
  #   @return [::Integer]
  #     Number of DataItems that were used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     DataItems used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  # @!attribute [rw] training_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for training this Model.
  # @!attribute [rw] validation_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for validating this Model during
  #     training.
  # @!attribute [rw] test_annotations_count
  #   @return [::Integer]
  #     Number of Annotations that are used for evaluating this Model. If the
  #     Model is evaluated multiple times, this will be the number of test
  #     Annotations used by the first evaluation. If the Model is not evaluated,
  #     the number is 0.
  class DataStats
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Contains information about the original Model if this Model is a copy.
  # @!attribute [r] model
  #   @return [::String]
  #     Output only. The resource name of the Model this Model is a copy of,
  #     including the revision. Format:
  #     `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
  class OriginalModelInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # User input field to specify the base model source. Currently it only
  # supports specifing the Model Garden models and Genie models.
  # @!attribute [rw] model_garden_source
  #   @return [::Google::Cloud::AIPlatform::V1::ModelGardenSource]
  #     Source information of Model Garden models.
  # @!attribute [rw] genie_source
  #   @return [::Google::Cloud::AIPlatform::V1::GenieSource]
  #     Information about the base model of Genie models.
  class BaseModelSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Identifies a type of Model's prediction resources.
  module DeploymentResourcesType
    # Should not be used.
    DEPLOYMENT_RESOURCES_TYPE_UNSPECIFIED = 0

    # Resources that are dedicated to the
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModel}, and that need
    # a higher degree of manual configuration.
    DEDICATED_RESOURCES = 1

    # Resources that to large degree are decided by Vertex AI, and require
    # only a modest additional configuration.
    AUTOMATIC_RESOURCES = 2

    # Resources that can be shared by multiple
    # {::Google::Cloud::AIPlatform::V1::DeployedModel DeployedModels}. A
    # pre-configured
    # {::Google::Cloud::AIPlatform::V1::DeploymentResourcePool DeploymentResourcePool}
    # is required.
    SHARED_RESOURCES = 3
  end
end