Class: Google::Cloud::DiscoveryEngine::V1beta::CustomTuningModel

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb

Overview

Metadata that describes a custom tuned model.

Defined Under Namespace

Modules: ModelState Classes: MetricsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated: Timestamp the Model was created at.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb', line 56

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

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

  # The state of the model.
  module ModelState
    # Default value.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is in a paused training state.
    TRAINING_PAUSED = 1

    # The model is currently training.
    TRAINING = 2

    # The model has successfully completed training.
    TRAINING_COMPLETE = 3

    # The model is ready for serving.
    READY_FOR_SERVING = 4

    # The model training failed.
    TRAINING_FAILED = 5

    # The model training finished successfully but metrics did not improve.
    NO_IMPROVEMENT = 6

    # Input data validation failed. Model training didn't start.
    INPUT_VALIDATION_FAILED = 7
  end
end

#display_name ⇒ ::String 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb', line 56

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

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

  # The state of the model.
  module ModelState
    # Default value.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is in a paused training state.
    TRAINING_PAUSED = 1

    # The model is currently training.
    TRAINING = 2

    # The model has successfully completed training.
    TRAINING_COMPLETE = 3

    # The model is ready for serving.
    READY_FOR_SERVING = 4

    # The model training failed.
    TRAINING_FAILED = 5

    # The model training finished successfully but metrics did not improve.
    NO_IMPROVEMENT = 6

    # Input data validation failed. Model training didn't start.
    INPUT_VALIDATION_FAILED = 7
  end
end

#error_message ⇒ ::String 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb', line 56

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

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

  # The state of the model.
  module ModelState
    # Default value.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is in a paused training state.
    TRAINING_PAUSED = 1

    # The model is currently training.
    TRAINING = 2

    # The model has successfully completed training.
    TRAINING_COMPLETE = 3

    # The model is ready for serving.
    READY_FOR_SERVING = 4

    # The model training failed.
    TRAINING_FAILED = 5

    # The model training finished successfully but metrics did not improve.
    NO_IMPROVEMENT = 6

    # Input data validation failed. Model training didn't start.
    INPUT_VALIDATION_FAILED = 7
  end
end

#metrics ⇒ ::Google::Protobuf::Map{::String => ::Float} 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb', line 56

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

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

  # The state of the model.
  module ModelState
    # Default value.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is in a paused training state.
    TRAINING_PAUSED = 1

    # The model is currently training.
    TRAINING = 2

    # The model has successfully completed training.
    TRAINING_COMPLETE = 3

    # The model is ready for serving.
    READY_FOR_SERVING = 4

    # The model training failed.
    TRAINING_FAILED = 5

    # The model training finished successfully but metrics did not improve.
    NO_IMPROVEMENT = 6

    # Input data validation failed. Model training didn't start.
    INPUT_VALIDATION_FAILED = 7
  end
end

#model_state ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::CustomTuningModel::ModelState 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb', line 56

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

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

  # The state of the model.
  module ModelState
    # Default value.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is in a paused training state.
    TRAINING_PAUSED = 1

    # The model is currently training.
    TRAINING = 2

    # The model has successfully completed training.
    TRAINING_COMPLETE = 3

    # The model is ready for serving.
    READY_FOR_SERVING = 4

    # The model training failed.
    TRAINING_FAILED = 5

    # The model training finished successfully but metrics did not improve.
    NO_IMPROVEMENT = 6

    # Input data validation failed. Model training didn't start.
    INPUT_VALIDATION_FAILED = 7
  end
end

#model_version ⇒ ::Integer 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb', line 56

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

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

  # The state of the model.
  module ModelState
    # Default value.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is in a paused training state.
    TRAINING_PAUSED = 1

    # The model is currently training.
    TRAINING = 2

    # The model has successfully completed training.
    TRAINING_COMPLETE = 3

    # The model is ready for serving.
    READY_FOR_SERVING = 4

    # The model training failed.
    TRAINING_FAILED = 5

    # The model training finished successfully but metrics did not improve.
    NO_IMPROVEMENT = 6

    # Input data validation failed. Model training didn't start.
    INPUT_VALIDATION_FAILED = 7
  end
end

#name ⇒ ::String 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb', line 56

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

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

  # The state of the model.
  module ModelState
    # Default value.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is in a paused training state.
    TRAINING_PAUSED = 1

    # The model is currently training.
    TRAINING = 2

    # The model has successfully completed training.
    TRAINING_COMPLETE = 3

    # The model is ready for serving.
    READY_FOR_SERVING = 4

    # The model training failed.
    TRAINING_FAILED = 5

    # The model training finished successfully but metrics did not improve.
    NO_IMPROVEMENT = 6

    # Input data validation failed. Model training didn't start.
    INPUT_VALIDATION_FAILED = 7
  end
end

#training_start_time ⇒ ::Google::Protobuf::Timestamp 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb', line 56

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

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

  # The state of the model.
  module ModelState
    # Default value.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is in a paused training state.
    TRAINING_PAUSED = 1

    # The model is currently training.
    TRAINING = 2

    # The model has successfully completed training.
    TRAINING_COMPLETE = 3

    # The model is ready for serving.
    READY_FOR_SERVING = 4

    # The model training failed.
    TRAINING_FAILED = 5

    # The model training finished successfully but metrics did not improve.
    NO_IMPROVEMENT = 6

    # Input data validation failed. Model training didn't start.
    INPUT_VALIDATION_FAILED = 7
  end
end