Struct AutoMlCandidate

#[non_exhaustive]
pub struct AutoMlCandidate {
    pub candidate_name: Option<String>,
    pub final_auto_ml_job_objective_metric: Option<FinalAutoMlJobObjectiveMetric>,
    pub objective_status: Option<ObjectiveStatus>,
    pub candidate_steps: Option<Vec<AutoMlCandidateStep>>,
    pub candidate_status: Option<CandidateStatus>,
    pub inference_containers: Option<Vec<AutoMlContainerDefinition>>,
    pub creation_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub last_modified_time: Option<DateTime>,
    pub failure_reason: Option<String>,
    pub candidate_properties: Option<CandidateProperties>,
    pub inference_container_definitions: Option<HashMap<AutoMlProcessingUnit, Vec<AutoMlContainerDefinition>>>,
}

Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

candidate_name: Option<String>

The name of the candidate.

final_auto_ml_job_objective_metric: Option<FinalAutoMlJobObjectiveMetric>

The best candidate result from an AutoML training job.

objective_status: Option<ObjectiveStatus>

The objective's status.

candidate_steps: Option<Vec<AutoMlCandidateStep>>

Information about the candidate's steps.

candidate_status: Option<CandidateStatus>

The candidate's status.

inference_containers: Option<Vec<AutoMlContainerDefinition>>

Information about the recommended inference container definitions.

creation_time: Option<DateTime>

The creation time.

end_time: Option<DateTime>

The end time.

last_modified_time: Option<DateTime>

The last modified time.

failure_reason: Option<String>

The failure reason.

candidate_properties: Option<CandidateProperties>

The properties of an AutoML candidate job.

inference_container_definitions: Option<HashMap<AutoMlProcessingUnit, Vec<AutoMlContainerDefinition>>>

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling CreateAutoMLJobV2) related to image or text classification problem types only.

Implementations

impl AutoMlCandidate

pub fn candidate_name(&self) -> Option<&str>

The name of the candidate.

pub fn final_auto_ml_job_objective_metric( &self, ) -> Option<&FinalAutoMlJobObjectiveMetric>

The best candidate result from an AutoML training job.

pub fn objective_status(&self) -> Option<&ObjectiveStatus>

The objective's status.

pub fn candidate_steps(&self) -> &[AutoMlCandidateStep]

Information about the candidate's steps.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .candidate_steps.is_none().

pub fn candidate_status(&self) -> Option<&CandidateStatus>

The candidate's status.

pub fn inference_containers(&self) -> &[AutoMlContainerDefinition]

Information about the recommended inference container definitions.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .inference_containers.is_none().

pub fn creation_time(&self) -> Option<&DateTime>

The creation time.

pub fn end_time(&self) -> Option<&DateTime>

The end time.

pub fn last_modified_time(&self) -> Option<&DateTime>

The last modified time.

pub fn failure_reason(&self) -> Option<&str>

The failure reason.

pub fn candidate_properties(&self) -> Option<&CandidateProperties>

The properties of an AutoML candidate job.

pub fn inference_container_definitions( &self, ) -> Option<&HashMap<AutoMlProcessingUnit, Vec<AutoMlContainerDefinition>>>

The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the AutoML jobs V2 (for example, for jobs created by calling CreateAutoMLJobV2) related to image or text classification problem types only.

impl AutoMlCandidate

pub fn builder() -> AutoMlCandidateBuilder

Creates a new builder-style object to manufacture AutoMlCandidate.

Trait Implementations

impl Clone for AutoMlCandidate

fn clone(&self) -> AutoMlCandidate

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AutoMlCandidate

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AutoMlCandidate

fn eq(&self, other: &AutoMlCandidate) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AutoMlCandidate