Class: Google::Cloud::FinancialServices::V1::BacktestResult

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

Overview

BacktestResult is created to test the performance of a model on a dataset.

Defined Under Namespace

Modules: State Classes: LabelsEntry, PerformanceTarget

Instance Attribute Summary collapse

Instance Attribute Details

#backtest_periods ⇒ ::Integer

Returns The number of consecutive months to conduct backtesting for, ending with the last full month prior to the end_time according to the dataset's timezone.

Returns:

  • (::Integer) —

    The number of consecutive months to conduct backtesting for, ending with the last full month prior to the end_time according to the dataset's timezone.



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
 
# File 'proto_docs/google/cloud/financialservices/v1/backtest_result.rb', line 70

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

  # 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

  # @!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
end

#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
 
# File 'proto_docs/google/cloud/financialservices/v1/backtest_result.rb', line 70

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

  # 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

  # @!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
end

#dataset ⇒ ::String

Returns Required. The resource name of the Dataset to backtest on Format: /projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}.

Returns:

  • (::String) —

    Required. The resource name of the Dataset to backtest on Format: /projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}



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
 
# File 'proto_docs/google/cloud/financialservices/v1/backtest_result.rb', line 70

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

  # 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

  # @!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
end

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns Required. End_time specifies the latest time from which labels are used and from which data is used to generate features for backtesting. End_time should be no later than the end of the date_range of the primary dataset.

Returns:

  • (::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 backtesting. End_time should be no later than the end of the date_range of the primary dataset.



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
 
# File 'proto_docs/google/cloud/financialservices/v1/backtest_result.rb', line 70

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

  # 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

  # @!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
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
 
# File 'proto_docs/google/cloud/financialservices/v1/backtest_result.rb', line 70

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

  # 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

  # @!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
end

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

Returns Output only. The line of business (Retail/Commercial) this backtest is for. Determined by Model, 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
 
# File 'proto_docs/google/cloud/financialservices/v1/backtest_result.rb', line 70

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

  # 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

  # @!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
end

#model ⇒ ::String

Returns Required. The resource name of the Model to use or to backtest. Format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}.

Returns:

  • (::String) —

    Required. The resource name of the Model to use or to backtest. Format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}



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
 
# File 'proto_docs/google/cloud/financialservices/v1/backtest_result.rb', line 70

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

  # 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

  # @!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
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the BacktestResult. format: /projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}.

Returns:

  • (::String) —

    Output only. The resource name of the BacktestResult. format: /projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}



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
 
# File 'proto_docs/google/cloud/financialservices/v1/backtest_result.rb', line 70

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

  # 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

  # @!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
end

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

Returns Required. PerformanceTarget gives information on how the test will be evaluated.

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
 
# File 'proto_docs/google/cloud/financialservices/v1/backtest_result.rb', line 70

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

  # 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

  # @!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
end

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

Returns Output only. State of the BacktestResult (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
 
# File 'proto_docs/google/cloud/financialservices/v1/backtest_result.rb', line 70

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

  # 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

  # @!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
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
 
# File 'proto_docs/google/cloud/financialservices/v1/backtest_result.rb', line 70

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

  # 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

  # @!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
end