Resource: BacktestResult
BacktestResult is created to test the performance of a model on a dataset.
JSON representation |
---|
{ "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "state": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the BacktestResult. format: "/projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtestResult}" |
createTime |
Output only. The timestamp of creation of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The timestamp of the most recent update of this resource. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
Labels An object containing a list of |
state |
Output only. State of the BacktestResult (creating, active, deleting, etc.) |
dataset |
Required. The resource name of the Dataset to backtest on Format: "/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}" |
model |
Required. The resource name of the Model to use to use to backtest. Format: "/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}" |
endTime |
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 dateRange of the primary dataset. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
backtestPeriods |
The number of consecutive months to conduct backtesting for, ending with the last full month prior to the endTime according to the dataset's timezone. |
performanceTarget |
Required. PerformanceTarget gives information on how the test will be evaluated. |
lineOfBusiness |
Output only. The line of business (Retail/Commercial) this backtest is for. Determined by Model, cannot be set by user. |
State
The possible states of a resource.
Enums | |
---|---|
STATE_UNSPECIFIED |
State is unspecified, should not occur. |
CREATING |
The resource has not finished being created. |
ACTIVE |
The resource is active/ready to be used. |
UPDATING |
The resource is in the process of being updated. |
DELETING |
The resource is in the process of being deleted. |
PerformanceTarget
PerformanceTarget gives hints on how to evaluate the performance of a model.
JSON representation |
---|
{ "partyInvestigationsPerPeriodHint": string } |
Fields | |
---|---|
partyInvestigationsPerPeriodHint |
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. |
Methods |
|
---|---|
|
Create a BacktestResult. |
|
Deletes a BacktestResult. |
|
Export governance information for a BacktestResult resource. |
|
Gets a BacktestResult. |
|
List BacktestResults. |
|
Updates the parameters of a single BacktestResult. |