Class: Google::Cloud::AIPlatform::V1::Study

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

Overview

A message representing a Study.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Time at which the study was created.

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 45

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

  # Describes the Study state.
  module State
    # The study state is unspecified.
    STATE_UNSPECIFIED = 0

    # The study is active.
    ACTIVE = 1

    # The study is stopped due to an internal error.
    INACTIVE = 2

    # The study is done when the service exhausts the parameter search space
    # or max_trial_count is reached.
    COMPLETED = 3
  end
end

#display_name ⇒ ::String

Returns Required. Describes the Study, default value is empty string.

Returns:

  • (::String) —

    Required. Describes the Study, default value is empty string.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 45

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

  # Describes the Study state.
  module State
    # The study state is unspecified.
    STATE_UNSPECIFIED = 0

    # The study is active.
    ACTIVE = 1

    # The study is stopped due to an internal error.
    INACTIVE = 2

    # The study is done when the service exhausts the parameter search space
    # or max_trial_count is reached.
    COMPLETED = 3
  end
end

#inactive_reason ⇒ ::String (readonly)

Returns Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.

Returns:

  • (::String) —

    Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 45

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

  # Describes the Study state.
  module State
    # The study state is unspecified.
    STATE_UNSPECIFIED = 0

    # The study is active.
    ACTIVE = 1

    # The study is stopped due to an internal error.
    INACTIVE = 2

    # The study is done when the service exhausts the parameter search space
    # or max_trial_count is reached.
    COMPLETED = 3
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The name of a study. The study's globally unique identifier. Format: projects/{project}/locations/{location}/studies/{study}.

Returns:

  • (::String) —

    Output only. The name of a study. The study's globally unique identifier. Format: projects/{project}/locations/{location}/studies/{study}



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 45

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

  # Describes the Study state.
  module State
    # The study state is unspecified.
    STATE_UNSPECIFIED = 0

    # The study is active.
    ACTIVE = 1

    # The study is stopped due to an internal error.
    INACTIVE = 2

    # The study is done when the service exhausts the parameter search space
    # or max_trial_count is reached.
    COMPLETED = 3
  end
end

#state ⇒ ::Google::Cloud::AIPlatform::V1::Study::State (readonly)

Returns Output only. The detailed state of a Study.

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 45

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

  # Describes the Study state.
  module State
    # The study state is unspecified.
    STATE_UNSPECIFIED = 0

    # The study is active.
    ACTIVE = 1

    # The study is stopped due to an internal error.
    INACTIVE = 2

    # The study is done when the service exhausts the parameter search space
    # or max_trial_count is reached.
    COMPLETED = 3
  end
end

#study_spec ⇒ ::Google::Cloud::AIPlatform::V1::StudySpec

Returns Required. Configuration of the Study.

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'proto_docs/google/cloud/aiplatform/v1/study.rb', line 45

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

  # Describes the Study state.
  module State
    # The study state is unspecified.
    STATE_UNSPECIFIED = 0

    # The study is active.
    ACTIVE = 1

    # The study is stopped due to an internal error.
    INACTIVE = 2

    # The study is done when the service exhausts the parameter search space
    # or max_trial_count is reached.
    COMPLETED = 3
  end
end