Struct aws_sdk_machinelearning::model::MlModel
source · [−]#[non_exhaustive]pub struct MlModel {Show 19 fields
pub ml_model_id: Option<String>,
pub training_data_source_id: Option<String>,
pub created_by_iam_user: Option<String>,
pub created_at: Option<DateTime>,
pub last_updated_at: Option<DateTime>,
pub name: Option<String>,
pub status: Option<EntityStatus>,
pub size_in_bytes: Option<i64>,
pub endpoint_info: Option<RealtimeEndpointInfo>,
pub training_parameters: Option<HashMap<String, String>>,
pub input_data_location_s3: Option<String>,
pub algorithm: Option<Algorithm>,
pub ml_model_type: Option<MlModelType>,
pub score_threshold: Option<f32>,
pub score_threshold_last_updated_at: Option<DateTime>,
pub message: Option<String>,
pub compute_time: Option<i64>,
pub finished_at: Option<DateTime>,
pub started_at: Option<DateTime>,
}
Expand description
Represents the output of a GetMLModel
operation.
The content consists of the detailed metadata and the current status of the MLModel
.
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.ml_model_id: Option<String>
The ID assigned to the MLModel
at creation.
training_data_source_id: Option<String>
The ID of the training DataSource
. The CreateMLModel
operation uses the TrainingDataSourceId
.
created_by_iam_user: Option<String>
The AWS user account from which the MLModel
was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
created_at: Option<DateTime>
The time that the MLModel
was created. The time is expressed in epoch time.
last_updated_at: Option<DateTime>
The time of the most recent edit to the MLModel
. The time is expressed in epoch time.
name: Option<String>
A user-supplied name or description of the MLModel
.
status: Option<EntityStatus>
The current status of an MLModel
. This element can have one of the following values:
-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to create anMLModel
. -
INPROGRESS
- The creation process is underway. -
FAILED
- The request to create anMLModel
didn't run to completion. The model isn't usable. -
COMPLETED
- The creation process completed successfully. -
DELETED
- TheMLModel
is marked as deleted. It isn't usable.
size_in_bytes: Option<i64>
Long integer type that is a 64-bit signed number.
endpoint_info: Option<RealtimeEndpointInfo>
The current endpoint of the MLModel
.
training_parameters: Option<HashMap<String, String>>
A list of the training parameters in the MLModel
. The list is implemented as a map of key-value pairs.
The following is the current set of training parameters:
-
sgd.maxMLModelSizeInBytes
- The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.The value is an integer that ranges from
100000
to2147483648
. The default value is33554432
. -
sgd.maxPasses
- The number of times that the training process traverses the observations to build theMLModel
. The value is an integer that ranges from1
to10000
. The default value is10
. -
sgd.shuffleType
- Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values areauto
andnone
. The default value isnone
. -
sgd.l1RegularizationAmount
- The coefficient regularization L1 norm, which controls overfitting the data by penalizing large coefficients. This parameter tends to drive coefficients to zero, resulting in sparse feature set. If you use this parameter, start by specifying a small value, such as1.0E-08
.The value is a double that ranges from
0
toMAX_DOUBLE
. The default is to not use L1 normalization. This parameter can't be used whenL2
is specified. Use this parameter sparingly. -
sgd.l2RegularizationAmount
- The coefficient regularization L2 norm, which controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as1.0E-08
.The value is a double that ranges from
0
toMAX_DOUBLE
. The default is to not use L2 normalization. This parameter can't be used whenL1
is specified. Use this parameter sparingly.
input_data_location_s3: Option<String>
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
algorithm: Option<Algorithm>
The algorithm used to train the MLModel
. The following algorithm is supported:
-
SGD
-- Stochastic gradient descent. The goal ofSGD
is to minimize the gradient of the loss function.
ml_model_type: Option<MlModelType>
Identifies the MLModel
category. The following are the available types:
-
REGRESSION
- Produces a numeric result. For example, "What price should a house be listed at?" -
BINARY
- Produces one of two possible results. For example, "Is this a child-friendly web site?". -
MULTICLASS
- Produces one of several possible results. For example, "Is this a HIGH-, LOW-, or MEDIUM-risk trade?".
score_threshold: Option<f32>
score_threshold_last_updated_at: Option<DateTime>
The time of the most recent edit to the ScoreThreshold
. The time is expressed in epoch time.
message: Option<String>
A description of the most recent details about accessing the MLModel
.
compute_time: Option<i64>
Long integer type that is a 64-bit signed number.
finished_at: Option<DateTime>
A timestamp represented in epoch time.
started_at: Option<DateTime>
A timestamp represented in epoch time.
Implementations
sourceimpl MlModel
impl MlModel
sourcepub fn ml_model_id(&self) -> Option<&str>
pub fn ml_model_id(&self) -> Option<&str>
The ID assigned to the MLModel
at creation.
sourcepub fn training_data_source_id(&self) -> Option<&str>
pub fn training_data_source_id(&self) -> Option<&str>
The ID of the training DataSource
. The CreateMLModel
operation uses the TrainingDataSourceId
.
sourcepub fn created_by_iam_user(&self) -> Option<&str>
pub fn created_by_iam_user(&self) -> Option<&str>
The AWS user account from which the MLModel
was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.
sourcepub fn created_at(&self) -> Option<&DateTime>
pub fn created_at(&self) -> Option<&DateTime>
The time that the MLModel
was created. The time is expressed in epoch time.
sourcepub fn last_updated_at(&self) -> Option<&DateTime>
pub fn last_updated_at(&self) -> Option<&DateTime>
The time of the most recent edit to the MLModel
. The time is expressed in epoch time.
sourcepub fn status(&self) -> Option<&EntityStatus>
pub fn status(&self) -> Option<&EntityStatus>
The current status of an MLModel
. This element can have one of the following values:
-
PENDING
- Amazon Machine Learning (Amazon ML) submitted a request to create anMLModel
. -
INPROGRESS
- The creation process is underway. -
FAILED
- The request to create anMLModel
didn't run to completion. The model isn't usable. -
COMPLETED
- The creation process completed successfully. -
DELETED
- TheMLModel
is marked as deleted. It isn't usable.
sourcepub fn size_in_bytes(&self) -> Option<i64>
pub fn size_in_bytes(&self) -> Option<i64>
Long integer type that is a 64-bit signed number.
sourcepub fn endpoint_info(&self) -> Option<&RealtimeEndpointInfo>
pub fn endpoint_info(&self) -> Option<&RealtimeEndpointInfo>
The current endpoint of the MLModel
.
sourcepub fn training_parameters(&self) -> Option<&HashMap<String, String>>
pub fn training_parameters(&self) -> Option<&HashMap<String, String>>
A list of the training parameters in the MLModel
. The list is implemented as a map of key-value pairs.
The following is the current set of training parameters:
-
sgd.maxMLModelSizeInBytes
- The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.The value is an integer that ranges from
100000
to2147483648
. The default value is33554432
. -
sgd.maxPasses
- The number of times that the training process traverses the observations to build theMLModel
. The value is an integer that ranges from1
to10000
. The default value is10
. -
sgd.shuffleType
- Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values areauto
andnone
. The default value isnone
. -
sgd.l1RegularizationAmount
- The coefficient regularization L1 norm, which controls overfitting the data by penalizing large coefficients. This parameter tends to drive coefficients to zero, resulting in sparse feature set. If you use this parameter, start by specifying a small value, such as1.0E-08
.The value is a double that ranges from
0
toMAX_DOUBLE
. The default is to not use L1 normalization. This parameter can't be used whenL2
is specified. Use this parameter sparingly. -
sgd.l2RegularizationAmount
- The coefficient regularization L2 norm, which controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as1.0E-08
.The value is a double that ranges from
0
toMAX_DOUBLE
. The default is to not use L2 normalization. This parameter can't be used whenL1
is specified. Use this parameter sparingly.
sourcepub fn input_data_location_s3(&self) -> Option<&str>
pub fn input_data_location_s3(&self) -> Option<&str>
The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
sourcepub fn algorithm(&self) -> Option<&Algorithm>
pub fn algorithm(&self) -> Option<&Algorithm>
The algorithm used to train the MLModel
. The following algorithm is supported:
-
SGD
-- Stochastic gradient descent. The goal ofSGD
is to minimize the gradient of the loss function.
sourcepub fn ml_model_type(&self) -> Option<&MlModelType>
pub fn ml_model_type(&self) -> Option<&MlModelType>
Identifies the MLModel
category. The following are the available types:
-
REGRESSION
- Produces a numeric result. For example, "What price should a house be listed at?" -
BINARY
- Produces one of two possible results. For example, "Is this a child-friendly web site?". -
MULTICLASS
- Produces one of several possible results. For example, "Is this a HIGH-, LOW-, or MEDIUM-risk trade?".
pub fn score_threshold(&self) -> Option<f32>
sourcepub fn score_threshold_last_updated_at(&self) -> Option<&DateTime>
pub fn score_threshold_last_updated_at(&self) -> Option<&DateTime>
The time of the most recent edit to the ScoreThreshold
. The time is expressed in epoch time.
sourcepub fn message(&self) -> Option<&str>
pub fn message(&self) -> Option<&str>
A description of the most recent details about accessing the MLModel
.
sourcepub fn compute_time(&self) -> Option<i64>
pub fn compute_time(&self) -> Option<i64>
Long integer type that is a 64-bit signed number.
sourcepub fn finished_at(&self) -> Option<&DateTime>
pub fn finished_at(&self) -> Option<&DateTime>
A timestamp represented in epoch time.
sourcepub fn started_at(&self) -> Option<&DateTime>
pub fn started_at(&self) -> Option<&DateTime>
A timestamp represented in epoch time.
Trait Implementations
impl StructuralPartialEq for MlModel
Auto Trait Implementations
impl RefUnwindSafe for MlModel
impl Send for MlModel
impl Sync for MlModel
impl Unpin for MlModel
impl UnwindSafe for MlModel
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more