datarobot (version 2.8.0)

CreateDatetimePartitionSpecification: Create a list describing datetime partition parameters

Description

Uniquely defines a DatetimePartitioning for some project

Usage

CreateDatetimePartitionSpecification(datetimePartitionColumn,
  autopilotDataSelectionMethod = NULL, validationDuration = NULL,
  holdoutStartDate = NULL, holdoutDuration = NULL, disableHoldout = NULL,
  gapDuration = NULL, numberOfBacktests = NULL, backtests = NULL,
  useTimeSeries = FALSE, defaultToAPriori = FALSE,
  featureDerivationWindowStart = NULL, featureDerivationWindowEnd = NULL,
  forecastWindowStart = NULL, forecastWindowEnd = NULL)

Arguments

datetimePartitionColumn

character. The name of the column whose values as dates are used to assign a row to a particular partition

autopilotDataSelectionMethod

character. Optional. Whether models created by the autopilot should use "rowCount" or "duration" as their dataSelectionMethod

validationDuration

character. Optional. The default validationDuration for the backtests

holdoutStartDate

character. The start date of holdout scoring data (RFC 3339 format). If holdoutStartDate is specified, holdoutDuration must also be specified.

holdoutDuration

character. Optional. The duration of the holdout scoring data. If holdoutDuration is specified, holdoutStartDate must also be specified.

disableHoldout

logical. Optional. Whether to suppress allocating the holdout fold. If set to TRUE, holdoutStartDate and holdoutDuration must not be specified.

gapDuration

character. Optional. The duration of the gap between training and holdout scoring data.

numberOfBacktests

integer. The number of backtests to use.

backtests

list. List of BacktestSpecification the exact specification of backtests to use. The indexes of the specified backtests should range from 0 to numberOfBacktests - 1. If any backtest is left unspecified, a default configuration will be chosen.

useTimeSeries

logical. Whether to create a time series project (if TRUE) or an OTV project which uses datetime partitioning (if FALSE). The default behaviour is to create an OTV project.

defaultToAPriori

logical. Whether to default to treating features as a priori. Defaults to FALSE. Only used for time series project. A priori features are expected to be known for dates in the future when making predictions (e.g., "is this a holiday").

featureDerivationWindowStart

integer. Optional. Offset into the past to define how far back relative to the forecast point the feature derivation window should start. Only used for time series projects. Expressed in terms of the timeUnit of the datetimePartitionColumn.

featureDerivationWindowEnd

integer. Optional. Offset into the past to define how far back relative to the forecast point the feature derivation window should end. Only used for time series projects. Expressed in terms of the timeUnit of the datetimePartitionColumn.

forecastWindowStart

integer. Optional. Offset into the future to define how far forward relative to the forceast point the forecaset window should start. Only used for time series projects. Expressed in terms of the timeUnit of the datetimePartitionColumn.

forecastWindowEnd

integer. Optional. Offset into the future to define how far forward relative to the forceast point the forecaset window should end. Only used for time series projects. Expressed in terms of the timeUnit of the datetimePartitionColumn.

Value

An S3 object of class 'partition' including the parameters required by the SetTarget function to generate a datetime partitioning of the modeling dataset.

Details

Includes only the attributes of DatetimePartitioning that are directly controllable by users, not those determined by the DataRobot application based on the project dataset and the user-controlled settings. This is the specification that should be passed to SetTarget via the partition parameter. To see the full partitioning based on the project dataset, GenerateDatetimePartition. All durations should be specified with a duration string such as those returned by the ConstructDurationString helper function.

Examples

# NOT RUN {
CreateDatetimePartitionSpecification("date_col")
# }