Class: Google::Cloud::FinancialServices::V1::EngineConfig

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

Overview

The EngineConfig resource creates the configuration for training a model.

Defined Under Namespace

Modules: HyperparameterSourceType, State Classes: HyperparameterSource, LabelsEntry, PerformanceTarget, Tuning

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. The timestamp of creation of this resource.

Returns:



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/financialservices/v1/engine_config.rb', line 70

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

  # The parameters needed for the tuning operation, these are used only in
  # tuning and not passed on to training.
  # @!attribute [rw] primary_dataset
  #   @return [::String]
  #     Required. The resource name of the Primary Dataset used in this model
  #     tuning. For information about how primary and auxiliary datasets are
  #     used, refer to the engine version's documentation.  Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. End_time specifies the latest time from which labels are used
  #     and from which data is used to generate features for tuning.  End_time
  #     should be no later than the end of the date_range of the dataset.
  class Tuning
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # PerformanceTarget gives hints on how to evaluate the performance of a
  # model.
  # @!attribute [rw] party_investigations_per_period_hint
  #   @return [::Integer]
  #     Required. A number that gives the tuner a hint on the number of parties
  #     from this data that will be investigated per period (monthly). This is
  #     used to control how the model is evaluated. For example, when trying AML
  #     AI for the first time, we recommend setting this to the number of parties
  #     investigated in an average month, based on alerts from your existing
  #     automated alerting system.
  class PerformanceTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for bootstrapping an Engine Config with the results of another
  # one.
  # @!attribute [rw] source_engine_config
  #   @return [::String]
  #     Required. The resource name of the source EngineConfig whose outputs are
  #     used. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`
  # @!attribute [r] source_engine_version
  #   @return [::String]
  #     Output only. The resource name of the EngineVersion that was used in the
  #     tuning run. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
  class HyperparameterSource
    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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end

  # The type of the hyperparameter source.
  module HyperparameterSourceType
    # Hyperparameter source type is unspecified, defaults to TUNING.
    HYPERPARAMETER_SOURCE_TYPE_UNSPECIFIED = 0

    # The EngineConfig creation starts a tuning job which selects the best
    # hyperparameters.
    TUNING = 1

    # The hyperparameters are inherited from another EngineConfig.
    INHERITED = 2
  end
end

#engine_version ⇒ ::String

Returns Required. The resource name of the EngineVersion used in this model tuning. format: /projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}.

Returns:

  • (::String) —

    Required. The resource name of the EngineVersion used in this model tuning. format: /projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/financialservices/v1/engine_config.rb', line 70

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

  # The parameters needed for the tuning operation, these are used only in
  # tuning and not passed on to training.
  # @!attribute [rw] primary_dataset
  #   @return [::String]
  #     Required. The resource name of the Primary Dataset used in this model
  #     tuning. For information about how primary and auxiliary datasets are
  #     used, refer to the engine version's documentation.  Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. End_time specifies the latest time from which labels are used
  #     and from which data is used to generate features for tuning.  End_time
  #     should be no later than the end of the date_range of the dataset.
  class Tuning
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # PerformanceTarget gives hints on how to evaluate the performance of a
  # model.
  # @!attribute [rw] party_investigations_per_period_hint
  #   @return [::Integer]
  #     Required. A number that gives the tuner a hint on the number of parties
  #     from this data that will be investigated per period (monthly). This is
  #     used to control how the model is evaluated. For example, when trying AML
  #     AI for the first time, we recommend setting this to the number of parties
  #     investigated in an average month, based on alerts from your existing
  #     automated alerting system.
  class PerformanceTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for bootstrapping an Engine Config with the results of another
  # one.
  # @!attribute [rw] source_engine_config
  #   @return [::String]
  #     Required. The resource name of the source EngineConfig whose outputs are
  #     used. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`
  # @!attribute [r] source_engine_version
  #   @return [::String]
  #     Output only. The resource name of the EngineVersion that was used in the
  #     tuning run. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
  class HyperparameterSource
    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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end

  # The type of the hyperparameter source.
  module HyperparameterSourceType
    # Hyperparameter source type is unspecified, defaults to TUNING.
    HYPERPARAMETER_SOURCE_TYPE_UNSPECIFIED = 0

    # The EngineConfig creation starts a tuning job which selects the best
    # hyperparameters.
    TUNING = 1

    # The hyperparameters are inherited from another EngineConfig.
    INHERITED = 2
  end
end

#hyperparameter_source ⇒ ::Google::Cloud::FinancialServices::V1::EngineConfig::HyperparameterSource

Returns Optional. Configuration of hyperparameters source EngineConfig.

Returns:



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/financialservices/v1/engine_config.rb', line 70

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

  # The parameters needed for the tuning operation, these are used only in
  # tuning and not passed on to training.
  # @!attribute [rw] primary_dataset
  #   @return [::String]
  #     Required. The resource name of the Primary Dataset used in this model
  #     tuning. For information about how primary and auxiliary datasets are
  #     used, refer to the engine version's documentation.  Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. End_time specifies the latest time from which labels are used
  #     and from which data is used to generate features for tuning.  End_time
  #     should be no later than the end of the date_range of the dataset.
  class Tuning
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # PerformanceTarget gives hints on how to evaluate the performance of a
  # model.
  # @!attribute [rw] party_investigations_per_period_hint
  #   @return [::Integer]
  #     Required. A number that gives the tuner a hint on the number of parties
  #     from this data that will be investigated per period (monthly). This is
  #     used to control how the model is evaluated. For example, when trying AML
  #     AI for the first time, we recommend setting this to the number of parties
  #     investigated in an average month, based on alerts from your existing
  #     automated alerting system.
  class PerformanceTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for bootstrapping an Engine Config with the results of another
  # one.
  # @!attribute [rw] source_engine_config
  #   @return [::String]
  #     Required. The resource name of the source EngineConfig whose outputs are
  #     used. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`
  # @!attribute [r] source_engine_version
  #   @return [::String]
  #     Output only. The resource name of the EngineVersion that was used in the
  #     tuning run. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
  class HyperparameterSource
    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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end

  # The type of the hyperparameter source.
  module HyperparameterSourceType
    # Hyperparameter source type is unspecified, defaults to TUNING.
    HYPERPARAMETER_SOURCE_TYPE_UNSPECIFIED = 0

    # The EngineConfig creation starts a tuning job which selects the best
    # hyperparameters.
    TUNING = 1

    # The hyperparameters are inherited from another EngineConfig.
    INHERITED = 2
  end
end

#hyperparameter_source_type ⇒ ::Google::Cloud::FinancialServices::V1::EngineConfig::HyperparameterSourceType

Returns Optional. The origin of hyperparameters for the created EngineConfig. The default is TUNING. In this case, the hyperparameters are selected as a result of a tuning run.

Returns:



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/financialservices/v1/engine_config.rb', line 70

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

  # The parameters needed for the tuning operation, these are used only in
  # tuning and not passed on to training.
  # @!attribute [rw] primary_dataset
  #   @return [::String]
  #     Required. The resource name of the Primary Dataset used in this model
  #     tuning. For information about how primary and auxiliary datasets are
  #     used, refer to the engine version's documentation.  Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. End_time specifies the latest time from which labels are used
  #     and from which data is used to generate features for tuning.  End_time
  #     should be no later than the end of the date_range of the dataset.
  class Tuning
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # PerformanceTarget gives hints on how to evaluate the performance of a
  # model.
  # @!attribute [rw] party_investigations_per_period_hint
  #   @return [::Integer]
  #     Required. A number that gives the tuner a hint on the number of parties
  #     from this data that will be investigated per period (monthly). This is
  #     used to control how the model is evaluated. For example, when trying AML
  #     AI for the first time, we recommend setting this to the number of parties
  #     investigated in an average month, based on alerts from your existing
  #     automated alerting system.
  class PerformanceTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for bootstrapping an Engine Config with the results of another
  # one.
  # @!attribute [rw] source_engine_config
  #   @return [::String]
  #     Required. The resource name of the source EngineConfig whose outputs are
  #     used. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`
  # @!attribute [r] source_engine_version
  #   @return [::String]
  #     Output only. The resource name of the EngineVersion that was used in the
  #     tuning run. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
  class HyperparameterSource
    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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end

  # The type of the hyperparameter source.
  module HyperparameterSourceType
    # Hyperparameter source type is unspecified, defaults to TUNING.
    HYPERPARAMETER_SOURCE_TYPE_UNSPECIFIED = 0

    # The EngineConfig creation starts a tuning job which selects the best
    # hyperparameters.
    TUNING = 1

    # The hyperparameters are inherited from another EngineConfig.
    INHERITED = 2
  end
end

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

Returns Labels.

Returns:

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

    Labels



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/financialservices/v1/engine_config.rb', line 70

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

  # The parameters needed for the tuning operation, these are used only in
  # tuning and not passed on to training.
  # @!attribute [rw] primary_dataset
  #   @return [::String]
  #     Required. The resource name of the Primary Dataset used in this model
  #     tuning. For information about how primary and auxiliary datasets are
  #     used, refer to the engine version's documentation.  Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. End_time specifies the latest time from which labels are used
  #     and from which data is used to generate features for tuning.  End_time
  #     should be no later than the end of the date_range of the dataset.
  class Tuning
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # PerformanceTarget gives hints on how to evaluate the performance of a
  # model.
  # @!attribute [rw] party_investigations_per_period_hint
  #   @return [::Integer]
  #     Required. A number that gives the tuner a hint on the number of parties
  #     from this data that will be investigated per period (monthly). This is
  #     used to control how the model is evaluated. For example, when trying AML
  #     AI for the first time, we recommend setting this to the number of parties
  #     investigated in an average month, based on alerts from your existing
  #     automated alerting system.
  class PerformanceTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for bootstrapping an Engine Config with the results of another
  # one.
  # @!attribute [rw] source_engine_config
  #   @return [::String]
  #     Required. The resource name of the source EngineConfig whose outputs are
  #     used. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`
  # @!attribute [r] source_engine_version
  #   @return [::String]
  #     Output only. The resource name of the EngineVersion that was used in the
  #     tuning run. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
  class HyperparameterSource
    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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end

  # The type of the hyperparameter source.
  module HyperparameterSourceType
    # Hyperparameter source type is unspecified, defaults to TUNING.
    HYPERPARAMETER_SOURCE_TYPE_UNSPECIFIED = 0

    # The EngineConfig creation starts a tuning job which selects the best
    # hyperparameters.
    TUNING = 1

    # The hyperparameters are inherited from another EngineConfig.
    INHERITED = 2
  end
end

#line_of_business ⇒ ::Google::Cloud::FinancialServices::V1::LineOfBusiness (readonly)

Returns Output only. The line of business (Retail/Commercial) this engine config is used for. Determined by EngineVersion, cannot be set by user.

Returns:



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/financialservices/v1/engine_config.rb', line 70

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

  # The parameters needed for the tuning operation, these are used only in
  # tuning and not passed on to training.
  # @!attribute [rw] primary_dataset
  #   @return [::String]
  #     Required. The resource name of the Primary Dataset used in this model
  #     tuning. For information about how primary and auxiliary datasets are
  #     used, refer to the engine version's documentation.  Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. End_time specifies the latest time from which labels are used
  #     and from which data is used to generate features for tuning.  End_time
  #     should be no later than the end of the date_range of the dataset.
  class Tuning
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # PerformanceTarget gives hints on how to evaluate the performance of a
  # model.
  # @!attribute [rw] party_investigations_per_period_hint
  #   @return [::Integer]
  #     Required. A number that gives the tuner a hint on the number of parties
  #     from this data that will be investigated per period (monthly). This is
  #     used to control how the model is evaluated. For example, when trying AML
  #     AI for the first time, we recommend setting this to the number of parties
  #     investigated in an average month, based on alerts from your existing
  #     automated alerting system.
  class PerformanceTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for bootstrapping an Engine Config with the results of another
  # one.
  # @!attribute [rw] source_engine_config
  #   @return [::String]
  #     Required. The resource name of the source EngineConfig whose outputs are
  #     used. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`
  # @!attribute [r] source_engine_version
  #   @return [::String]
  #     Output only. The resource name of the EngineVersion that was used in the
  #     tuning run. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
  class HyperparameterSource
    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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end

  # The type of the hyperparameter source.
  module HyperparameterSourceType
    # Hyperparameter source type is unspecified, defaults to TUNING.
    HYPERPARAMETER_SOURCE_TYPE_UNSPECIFIED = 0

    # The EngineConfig creation starts a tuning job which selects the best
    # hyperparameters.
    TUNING = 1

    # The hyperparameters are inherited from another EngineConfig.
    INHERITED = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the EngineConfig. format: /projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}.

Returns:

  • (::String) —

    Output only. The resource name of the EngineConfig. format: /projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/financialservices/v1/engine_config.rb', line 70

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

  # The parameters needed for the tuning operation, these are used only in
  # tuning and not passed on to training.
  # @!attribute [rw] primary_dataset
  #   @return [::String]
  #     Required. The resource name of the Primary Dataset used in this model
  #     tuning. For information about how primary and auxiliary datasets are
  #     used, refer to the engine version's documentation.  Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. End_time specifies the latest time from which labels are used
  #     and from which data is used to generate features for tuning.  End_time
  #     should be no later than the end of the date_range of the dataset.
  class Tuning
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # PerformanceTarget gives hints on how to evaluate the performance of a
  # model.
  # @!attribute [rw] party_investigations_per_period_hint
  #   @return [::Integer]
  #     Required. A number that gives the tuner a hint on the number of parties
  #     from this data that will be investigated per period (monthly). This is
  #     used to control how the model is evaluated. For example, when trying AML
  #     AI for the first time, we recommend setting this to the number of parties
  #     investigated in an average month, based on alerts from your existing
  #     automated alerting system.
  class PerformanceTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for bootstrapping an Engine Config with the results of another
  # one.
  # @!attribute [rw] source_engine_config
  #   @return [::String]
  #     Required. The resource name of the source EngineConfig whose outputs are
  #     used. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`
  # @!attribute [r] source_engine_version
  #   @return [::String]
  #     Output only. The resource name of the EngineVersion that was used in the
  #     tuning run. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
  class HyperparameterSource
    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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end

  # The type of the hyperparameter source.
  module HyperparameterSourceType
    # Hyperparameter source type is unspecified, defaults to TUNING.
    HYPERPARAMETER_SOURCE_TYPE_UNSPECIFIED = 0

    # The EngineConfig creation starts a tuning job which selects the best
    # hyperparameters.
    TUNING = 1

    # The hyperparameters are inherited from another EngineConfig.
    INHERITED = 2
  end
end

#performance_target ⇒ ::Google::Cloud::FinancialServices::V1::EngineConfig::PerformanceTarget

Returns Optional. PerformanceTarget gives information on how the tuning and training will be evaluated. This field is required if hyperparameter_source.type is not INHERITED, and output-only otherwise.

Returns:



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/financialservices/v1/engine_config.rb', line 70

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

  # The parameters needed for the tuning operation, these are used only in
  # tuning and not passed on to training.
  # @!attribute [rw] primary_dataset
  #   @return [::String]
  #     Required. The resource name of the Primary Dataset used in this model
  #     tuning. For information about how primary and auxiliary datasets are
  #     used, refer to the engine version's documentation.  Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. End_time specifies the latest time from which labels are used
  #     and from which data is used to generate features for tuning.  End_time
  #     should be no later than the end of the date_range of the dataset.
  class Tuning
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # PerformanceTarget gives hints on how to evaluate the performance of a
  # model.
  # @!attribute [rw] party_investigations_per_period_hint
  #   @return [::Integer]
  #     Required. A number that gives the tuner a hint on the number of parties
  #     from this data that will be investigated per period (monthly). This is
  #     used to control how the model is evaluated. For example, when trying AML
  #     AI for the first time, we recommend setting this to the number of parties
  #     investigated in an average month, based on alerts from your existing
  #     automated alerting system.
  class PerformanceTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for bootstrapping an Engine Config with the results of another
  # one.
  # @!attribute [rw] source_engine_config
  #   @return [::String]
  #     Required. The resource name of the source EngineConfig whose outputs are
  #     used. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`
  # @!attribute [r] source_engine_version
  #   @return [::String]
  #     Output only. The resource name of the EngineVersion that was used in the
  #     tuning run. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
  class HyperparameterSource
    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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end

  # The type of the hyperparameter source.
  module HyperparameterSourceType
    # Hyperparameter source type is unspecified, defaults to TUNING.
    HYPERPARAMETER_SOURCE_TYPE_UNSPECIFIED = 0

    # The EngineConfig creation starts a tuning job which selects the best
    # hyperparameters.
    TUNING = 1

    # The hyperparameters are inherited from another EngineConfig.
    INHERITED = 2
  end
end

#state ⇒ ::Google::Cloud::FinancialServices::V1::EngineConfig::State (readonly)

Returns Output only. State of the EngineConfig (creating, active, deleting, etc.).

Returns:



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/financialservices/v1/engine_config.rb', line 70

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

  # The parameters needed for the tuning operation, these are used only in
  # tuning and not passed on to training.
  # @!attribute [rw] primary_dataset
  #   @return [::String]
  #     Required. The resource name of the Primary Dataset used in this model
  #     tuning. For information about how primary and auxiliary datasets are
  #     used, refer to the engine version's documentation.  Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. End_time specifies the latest time from which labels are used
  #     and from which data is used to generate features for tuning.  End_time
  #     should be no later than the end of the date_range of the dataset.
  class Tuning
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # PerformanceTarget gives hints on how to evaluate the performance of a
  # model.
  # @!attribute [rw] party_investigations_per_period_hint
  #   @return [::Integer]
  #     Required. A number that gives the tuner a hint on the number of parties
  #     from this data that will be investigated per period (monthly). This is
  #     used to control how the model is evaluated. For example, when trying AML
  #     AI for the first time, we recommend setting this to the number of parties
  #     investigated in an average month, based on alerts from your existing
  #     automated alerting system.
  class PerformanceTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for bootstrapping an Engine Config with the results of another
  # one.
  # @!attribute [rw] source_engine_config
  #   @return [::String]
  #     Required. The resource name of the source EngineConfig whose outputs are
  #     used. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`
  # @!attribute [r] source_engine_version
  #   @return [::String]
  #     Output only. The resource name of the EngineVersion that was used in the
  #     tuning run. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
  class HyperparameterSource
    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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end

  # The type of the hyperparameter source.
  module HyperparameterSourceType
    # Hyperparameter source type is unspecified, defaults to TUNING.
    HYPERPARAMETER_SOURCE_TYPE_UNSPECIFIED = 0

    # The EngineConfig creation starts a tuning job which selects the best
    # hyperparameters.
    TUNING = 1

    # The hyperparameters are inherited from another EngineConfig.
    INHERITED = 2
  end
end

#tuning ⇒ ::Google::Cloud::FinancialServices::V1::EngineConfig::Tuning

Returns Optional. Configuration for tuning in creation of the EngineConfig. This field is required if hyperparameter_source.type is not INHERITED, and output-only otherwise.

Returns:



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/financialservices/v1/engine_config.rb', line 70

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

  # The parameters needed for the tuning operation, these are used only in
  # tuning and not passed on to training.
  # @!attribute [rw] primary_dataset
  #   @return [::String]
  #     Required. The resource name of the Primary Dataset used in this model
  #     tuning. For information about how primary and auxiliary datasets are
  #     used, refer to the engine version's documentation.  Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. End_time specifies the latest time from which labels are used
  #     and from which data is used to generate features for tuning.  End_time
  #     should be no later than the end of the date_range of the dataset.
  class Tuning
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # PerformanceTarget gives hints on how to evaluate the performance of a
  # model.
  # @!attribute [rw] party_investigations_per_period_hint
  #   @return [::Integer]
  #     Required. A number that gives the tuner a hint on the number of parties
  #     from this data that will be investigated per period (monthly). This is
  #     used to control how the model is evaluated. For example, when trying AML
  #     AI for the first time, we recommend setting this to the number of parties
  #     investigated in an average month, based on alerts from your existing
  #     automated alerting system.
  class PerformanceTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for bootstrapping an Engine Config with the results of another
  # one.
  # @!attribute [rw] source_engine_config
  #   @return [::String]
  #     Required. The resource name of the source EngineConfig whose outputs are
  #     used. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`
  # @!attribute [r] source_engine_version
  #   @return [::String]
  #     Output only. The resource name of the EngineVersion that was used in the
  #     tuning run. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
  class HyperparameterSource
    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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end

  # The type of the hyperparameter source.
  module HyperparameterSourceType
    # Hyperparameter source type is unspecified, defaults to TUNING.
    HYPERPARAMETER_SOURCE_TYPE_UNSPECIFIED = 0

    # The EngineConfig creation starts a tuning job which selects the best
    # hyperparameters.
    TUNING = 1

    # The hyperparameters are inherited from another EngineConfig.
    INHERITED = 2
  end
end

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

Returns Output only. The timestamp of the most recent update of this resource.

Returns:



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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/cloud/financialservices/v1/engine_config.rb', line 70

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

  # The parameters needed for the tuning operation, these are used only in
  # tuning and not passed on to training.
  # @!attribute [rw] primary_dataset
  #   @return [::String]
  #     Required. The resource name of the Primary Dataset used in this model
  #     tuning. For information about how primary and auxiliary datasets are
  #     used, refer to the engine version's documentation.  Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. End_time specifies the latest time from which labels are used
  #     and from which data is used to generate features for tuning.  End_time
  #     should be no later than the end of the date_range of the dataset.
  class Tuning
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # PerformanceTarget gives hints on how to evaluate the performance of a
  # model.
  # @!attribute [rw] party_investigations_per_period_hint
  #   @return [::Integer]
  #     Required. A number that gives the tuner a hint on the number of parties
  #     from this data that will be investigated per period (monthly). This is
  #     used to control how the model is evaluated. For example, when trying AML
  #     AI for the first time, we recommend setting this to the number of parties
  #     investigated in an average month, based on alerts from your existing
  #     automated alerting system.
  class PerformanceTarget
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Parameters for bootstrapping an Engine Config with the results of another
  # one.
  # @!attribute [rw] source_engine_config
  #   @return [::String]
  #     Required. The resource name of the source EngineConfig whose outputs are
  #     used. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`
  # @!attribute [r] source_engine_version
  #   @return [::String]
  #     Output only. The resource name of the EngineVersion that was used in the
  #     tuning run. Format:
  #     `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
  class HyperparameterSource
    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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end

  # The type of the hyperparameter source.
  module HyperparameterSourceType
    # Hyperparameter source type is unspecified, defaults to TUNING.
    HYPERPARAMETER_SOURCE_TYPE_UNSPECIFIED = 0

    # The EngineConfig creation starts a tuning job which selects the best
    # hyperparameters.
    TUNING = 1

    # The hyperparameters are inherited from another EngineConfig.
    INHERITED = 2
  end
end