Class: Google::Cloud::AIPlatform::V1::TensorboardExperiment

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

Overview

A TensorboardExperiment is a group of TensorboardRuns, that are typically the results of a training job run, in a Tensorboard.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Timestamp when this TensorboardExperiment was created.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb', line 70

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

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

#description ⇒ ::String

Returns Description of this TensorboardExperiment.

Returns:

  • (::String) —

    Description of this TensorboardExperiment.



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb', line 70

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

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

#display_name ⇒ ::String

Returns User provided name of this TensorboardExperiment.

Returns:

  • (::String) —

    User provided name of this TensorboardExperiment.



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb', line 70

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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.



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb', line 70

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

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

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

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

Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset:

  • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] title.

Returns:

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

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

    Label keys and values cannot be longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded).

    See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with aiplatform.googleapis.com/ and are immutable. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] title.


70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb', line 70

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

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

#name ⇒ ::String (readonly)

Returns Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}.

Returns:

  • (::String) —

    Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb', line 70

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

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

#source ⇒ ::String

Returns Immutable. Source of the TensorboardExperiment. Example: a custom training job.

Returns:

  • (::String) —

    Immutable. Source of the TensorboardExperiment. Example: a custom training job.



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb', line 70

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

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

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

Returns Output only. Timestamp when this TensorboardExperiment was last updated.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'proto_docs/google/cloud/aiplatform/v1/tensorboard_experiment.rb', line 70

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

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