Skip to content

Create Retraining Scheduler

lookoutequipment_create_retraining_scheduler R Documentation

Creates a retraining scheduler on the specified model

Description

Creates a retraining scheduler on the specified model.

Usage

lookoutequipment_create_retraining_scheduler(ModelName,
  RetrainingStartDate, RetrainingFrequency, LookbackWindow, PromoteMode,
  ClientToken)

Arguments

ModelName

[required] The name of the model to add the retraining scheduler to.

RetrainingStartDate

The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.

RetrainingFrequency

[required] This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in terms of Years, Months, and/or Days (note: other parameters like Time are not currently supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For example, the following values are valid:

  • P3M15D – Every 3 months and 15 days

  • P2M – Every 2 months

  • P150D – Every 150 days

LookbackWindow

[required] The number of past days of data that will be used for retraining.

PromoteMode

Indicates how the service will use new models. In MANAGED mode, new models will automatically be used for inference if they have better performance than the current model. In MANUAL mode, the new models will not be used until they are manually activated.

ClientToken

[required] A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

Value

A list with the following syntax: 

list(
  ModelName = "string",
  ModelArn = "string",
  Status = "PENDING"|"RUNNING"|"STOPPING"|"STOPPED"
)

Request syntax

svc$create_retraining_scheduler(
  ModelName = "string",
  RetrainingStartDate = as.POSIXct(
    "2015-01-01"
  ),
  RetrainingFrequency = "string",
  LookbackWindow = "string",
  PromoteMode = "MANAGED"|"MANUAL",
  ClientToken = "string"
)

Examples

## Not run: 
# 
svc$create_retraining_scheduler(
  ClientToken = "sample-client-token",
  LookbackWindow = "P360D",
  ModelName = "sample-model",
  PromoteMode = "MANUAL",
  RetrainingFrequency = "P1M"
)

# 
svc$create_retraining_scheduler(
  ClientToken = "sample-client-token",
  LookbackWindow = "P360D",
  ModelName = "sample-model",
  RetrainingFrequency = "P1M",
  RetrainingStartDate = "2024-01-01T00:00:00Z"
)

## End(Not run)