Reference documentation and code samples for the Financial Services V1 API class Google::Cloud::FinancialServices::V1::BacktestResult.
BacktestResult is created to test the performance of a model on a dataset.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#backtest_periods
def backtest_periods() -> ::Integer
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.
#backtest_periods=
def backtest_periods=(value) -> ::Integer
Parameter
- value (::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.
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.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The timestamp of creation of this resource.
#dataset
def dataset() -> ::String
Returns
-
(::String) — Required. The resource name of the Dataset to backtest on
Format:
/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}
#dataset=
def dataset=(value) -> ::String
Parameter
-
value (::String) — 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}
#end_time
def end_time() -> ::Google::Protobuf::Timestamp
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.
#end_time=
def end_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::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.
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.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Labels
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Labels
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Labels
#line_of_business
def line_of_business() -> ::Google::Cloud::FinancialServices::V1::LineOfBusiness
Returns
- (::Google::Cloud::FinancialServices::V1::LineOfBusiness) — Output only. The line of business (Retail/Commercial) this backtest is for. Determined by Model, cannot be set by user.
#model
def model() -> ::String
Returns
-
(::String) — Required. The resource name of the Model to use or to backtest.
Format:
/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}
#model=
def model=(value) -> ::String
Parameter
-
value (::String) — 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}
#name
def name() -> ::String
Returns
-
(::String) — Output only. The resource name of the BacktestResult.
format:
/projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}
#performance_target
def performance_target() -> ::Google::Cloud::FinancialServices::V1::BacktestResult::PerformanceTarget
Returns
- (::Google::Cloud::FinancialServices::V1::BacktestResult::PerformanceTarget) — Required. PerformanceTarget gives information on how the test will be evaluated.
#performance_target=
def performance_target=(value) -> ::Google::Cloud::FinancialServices::V1::BacktestResult::PerformanceTarget
Parameter
- value (::Google::Cloud::FinancialServices::V1::BacktestResult::PerformanceTarget) — Required. PerformanceTarget gives information on how the test will be evaluated.
Returns
- (::Google::Cloud::FinancialServices::V1::BacktestResult::PerformanceTarget) — Required. PerformanceTarget gives information on how the test will be evaluated.
#state
def state() -> ::Google::Cloud::FinancialServices::V1::BacktestResult::State
Returns
- (::Google::Cloud::FinancialServices::V1::BacktestResult::State) — Output only. State of the BacktestResult (creating, active, deleting, etc.)
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The timestamp of the most recent update of this resource.