Struct aws_sdk_forecast::types::FeaturizationConfig
source · #[non_exhaustive]pub struct FeaturizationConfig {
pub forecast_frequency: String,
pub forecast_dimensions: Option<Vec<String>>,
pub featurizations: Option<Vec<Featurization>>,
}
Expand description
This object belongs to the CreatePredictor
operation. If you created your predictor with CreateAutoPredictor
, see AttributeConfig
.
In a CreatePredictor
operation, the specified algorithm trains a model using the specified dataset group. You can optionally tell the operation to modify data fields prior to training a model. These modifications are referred to as featurization.
You define featurization using the FeaturizationConfig
object. You specify an array of transformations, one for each field that you want to featurize. You then include the FeaturizationConfig
object in your CreatePredictor
request. Amazon Forecast applies the featurization to the TARGET_TIME_SERIES
and RELATED_TIME_SERIES
datasets before model training.
You can create multiple featurization configurations. For example, you might call the CreatePredictor
operation twice by specifying different featurization configurations.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.forecast_frequency: String
The frequency of predictions in a forecast.
Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:
-
Minute - 1-59
-
Hour - 1-23
-
Day - 1-6
-
Week - 1-4
-
Month - 1-11
-
Year - 1
Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify "3M".
The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.
When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the TARGET_TIME_SERIES dataset frequency.
forecast_dimensions: Option<Vec<String>>
An array of dimension (field) names that specify how to group the generated forecast.
For example, suppose that you are generating a forecast for item sales across all of your stores, and your dataset contains a store_id
field. If you want the sales forecast for each item by store, you would specify store_id
as the dimension.
All forecast dimensions specified in the TARGET_TIME_SERIES
dataset don't need to be specified in the CreatePredictor
request. All forecast dimensions specified in the RELATED_TIME_SERIES
dataset must be specified in the CreatePredictor
request.
featurizations: Option<Vec<Featurization>>
An array of featurization (transformation) information for the fields of a dataset.
Implementations§
source§impl FeaturizationConfig
impl FeaturizationConfig
sourcepub fn forecast_frequency(&self) -> &str
pub fn forecast_frequency(&self) -> &str
The frequency of predictions in a forecast.
Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:
-
Minute - 1-59
-
Hour - 1-23
-
Day - 1-6
-
Week - 1-4
-
Month - 1-11
-
Year - 1
Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify "3M".
The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.
When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the TARGET_TIME_SERIES dataset frequency.
sourcepub fn forecast_dimensions(&self) -> &[String]
pub fn forecast_dimensions(&self) -> &[String]
An array of dimension (field) names that specify how to group the generated forecast.
For example, suppose that you are generating a forecast for item sales across all of your stores, and your dataset contains a store_id
field. If you want the sales forecast for each item by store, you would specify store_id
as the dimension.
All forecast dimensions specified in the TARGET_TIME_SERIES
dataset don't need to be specified in the CreatePredictor
request. All forecast dimensions specified in the RELATED_TIME_SERIES
dataset must be specified in the CreatePredictor
request.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .forecast_dimensions.is_none()
.
sourcepub fn featurizations(&self) -> &[Featurization]
pub fn featurizations(&self) -> &[Featurization]
An array of featurization (transformation) information for the fields of a dataset.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .featurizations.is_none()
.
source§impl FeaturizationConfig
impl FeaturizationConfig
sourcepub fn builder() -> FeaturizationConfigBuilder
pub fn builder() -> FeaturizationConfigBuilder
Creates a new builder-style object to manufacture FeaturizationConfig
.
Trait Implementations§
source§impl Clone for FeaturizationConfig
impl Clone for FeaturizationConfig
source§fn clone(&self) -> FeaturizationConfig
fn clone(&self) -> FeaturizationConfig
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for FeaturizationConfig
impl Debug for FeaturizationConfig
source§impl PartialEq for FeaturizationConfig
impl PartialEq for FeaturizationConfig
source§fn eq(&self, other: &FeaturizationConfig) -> bool
fn eq(&self, other: &FeaturizationConfig) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for FeaturizationConfig
Auto Trait Implementations§
impl Freeze for FeaturizationConfig
impl RefUnwindSafe for FeaturizationConfig
impl Send for FeaturizationConfig
impl Sync for FeaturizationConfig
impl Unpin for FeaturizationConfig
impl UnwindSafe for FeaturizationConfig
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more