Class: Google::Cloud::AIPlatform::V1::ExportDataConfig

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

Overview

Describes what part of the Dataset is to be exported, the destination of the export and how to export.

Defined Under Namespace

Modules: ExportUse

Instance Attribute Summary collapse

Instance Attribute Details

#annotation_schema_uri ⇒ ::String

Returns The Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with metadata of the Dataset specified by ExportDataRequest.name.

Only used for custom training data export use cases. Only applicable to Datasets that have DataItems and Annotations.

Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on.

When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.

Returns:

  • (::String) —

    The Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with metadata of the Dataset specified by ExportDataRequest.name.

    Only used for custom training data export use cases. Only applicable to Datasets that have DataItems and Annotations.

    Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on.

    When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 256

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

  # ExportUse indicates the usage of the exported files. It restricts file
  # destination, format, annotations to be exported, whether to allow
  # unannotated data to be exported and whether to clone files to temp Cloud
  # Storage bucket.
  module ExportUse
    # Regular user export.
    EXPORT_USE_UNSPECIFIED = 0

    # Export for custom code training.
    CUSTOM_CODE_TRAINING = 6
  end
end

#annotations_filter ⇒ ::String

Returns An expression for filtering what part of the Dataset is to be exported. Only Annotations that match this filter will be exported. The filter syntax is the same as in ListAnnotations.

Returns:

  • (::String) —

    An expression for filtering what part of the Dataset is to be exported. Only Annotations that match this filter will be exported. The filter syntax is the same as in ListAnnotations.



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 256

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

  # ExportUse indicates the usage of the exported files. It restricts file
  # destination, format, annotations to be exported, whether to allow
  # unannotated data to be exported and whether to clone files to temp Cloud
  # Storage bucket.
  module ExportUse
    # Regular user export.
    EXPORT_USE_UNSPECIFIED = 0

    # Export for custom code training.
    CUSTOM_CODE_TRAINING = 6
  end
end

#export_use ⇒ ::Google::Cloud::AIPlatform::V1::ExportDataConfig::ExportUse

Returns Indicates the usage of the exported files.

Returns:



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 256

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

  # ExportUse indicates the usage of the exported files. It restricts file
  # destination, format, annotations to be exported, whether to allow
  # unannotated data to be exported and whether to clone files to temp Cloud
  # Storage bucket.
  module ExportUse
    # Regular user export.
    EXPORT_USE_UNSPECIFIED = 0

    # Export for custom code training.
    CUSTOM_CODE_TRAINING = 6
  end
end

#filter_split ⇒ ::Google::Cloud::AIPlatform::V1::ExportFilterSplit

Returns Split based on the provided filters for each set.

Returns:



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 256

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

  # ExportUse indicates the usage of the exported files. It restricts file
  # destination, format, annotations to be exported, whether to allow
  # unannotated data to be exported and whether to clone files to temp Cloud
  # Storage bucket.
  module ExportUse
    # Regular user export.
    EXPORT_USE_UNSPECIFIED = 0

    # Export for custom code training.
    CUSTOM_CODE_TRAINING = 6
  end
end

#fraction_split ⇒ ::Google::Cloud::AIPlatform::V1::ExportFractionSplit

Returns Split based on fractions defining the size of each set.

Returns:



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 256

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

  # ExportUse indicates the usage of the exported files. It restricts file
  # destination, format, annotations to be exported, whether to allow
  # unannotated data to be exported and whether to clone files to temp Cloud
  # Storage bucket.
  module ExportUse
    # Regular user export.
    EXPORT_USE_UNSPECIFIED = 0

    # Export for custom code training.
    CUSTOM_CODE_TRAINING = 6
  end
end

#gcs_destination ⇒ ::Google::Cloud::AIPlatform::V1::GcsDestination

Returns The Google Cloud Storage location where the output is to be written to. In the given directory a new directory will be created with name: export-data-<dataset-display-name>-<timestamp-of-export-call> where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export output will be written into that directory. Inside that directory, annotations with the same schema will be grouped into sub directories which are named with the corresponding annotations' schema title. Inside these sub directories, a schema.yaml will be created to describe the output format.

Returns:

  • (::Google::Cloud::AIPlatform::V1::GcsDestination) —

    The Google Cloud Storage location where the output is to be written to. In the given directory a new directory will be created with name: export-data-<dataset-display-name>-<timestamp-of-export-call> where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export output will be written into that directory. Inside that directory, annotations with the same schema will be grouped into sub directories which are named with the corresponding annotations' schema title. Inside these sub directories, a schema.yaml will be created to describe the output format.



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 256

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

  # ExportUse indicates the usage of the exported files. It restricts file
  # destination, format, annotations to be exported, whether to allow
  # unannotated data to be exported and whether to clone files to temp Cloud
  # Storage bucket.
  module ExportUse
    # Regular user export.
    EXPORT_USE_UNSPECIFIED = 0

    # Export for custom code training.
    CUSTOM_CODE_TRAINING = 6
  end
end

#saved_query_id ⇒ ::String

Returns The ID of a SavedQuery (annotation set) under the Dataset specified by ExportDataRequest.name used for filtering Annotations for training.

Only used for custom training data export use cases. Only applicable to Datasets that have SavedQueries.

Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter.

Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.

Returns:

  • (::String) —

    The ID of a SavedQuery (annotation set) under the Dataset specified by ExportDataRequest.name used for filtering Annotations for training.

    Only used for custom training data export use cases. Only applicable to Datasets that have SavedQueries.

    Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter.

    Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'proto_docs/google/cloud/aiplatform/v1/dataset.rb', line 256

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

  # ExportUse indicates the usage of the exported files. It restricts file
  # destination, format, annotations to be exported, whether to allow
  # unannotated data to be exported and whether to clone files to temp Cloud
  # Storage bucket.
  module ExportUse
    # Regular user export.
    EXPORT_USE_UNSPECIFIED = 0

    # Export for custom code training.
    CUSTOM_CODE_TRAINING = 6
  end
end