Skip to content

AutoMLCandidate

Source code in docs_src/capo_sagemaker/types/auto_ml_candidate.py
class AutoMLCandidate(TypedDict, closed=True):
    candidate_name: NotRequired["capo_sagemaker.types.candidate_name.CandidateName"]
    """<p>The name of the candidate.</p>"""
    final_auto_ml_job_objective_metric: NotRequired[
        "capo_sagemaker.types.final_auto_ml_job_objective_metric.FinalAutoMLJobObjectiveMetric"
    ]
    objective_status: NotRequired[
        "capo_sagemaker.types.objective_status.ObjectiveStatus"
    ]
    """<p>The objective's status.</p>"""
    candidate_steps: NotRequired["capo_sagemaker.types.candidate_steps.CandidateSteps"]
    """<p>Information about the candidate's steps.</p>"""
    candidate_status: NotRequired[
        "capo_sagemaker.types.candidate_status.CandidateStatus"
    ]
    """<p>The candidate's status.</p>"""
    inference_containers: NotRequired[
        "capo_sagemaker.types.auto_ml_container_definitions.AutoMLContainerDefinitions"
    ]
    """<p>Information about the recommended inference container definitions.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The creation time.</p>"""
    end_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The end time.</p>"""
    last_modified_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The last modified time.</p>"""
    failure_reason: NotRequired[
        "capo_sagemaker.types.auto_ml_failure_reason.AutoMLFailureReason"
    ]
    """<p>The failure reason.</p>"""
    candidate_properties: NotRequired[
        "capo_sagemaker.types.candidate_properties.CandidateProperties"
    ]
    """<p>The properties of an AutoML candidate job.</p>"""
    inference_container_definitions: NotRequired[
        "capo_sagemaker.types.auto_ml_inference_container_definitions.AutoMLInferenceContainerDefinitions"
    ]
    """<p>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 <code>CreateAutoMLJobV2</code>) related to image or text classification problem types only.</p>"""

candidate_name instance-attribute

candidate_name: NotRequired[CandidateName]

The name of the candidate.

candidate_properties instance-attribute

candidate_properties: NotRequired[CandidateProperties]

The properties of an AutoML candidate job.

candidate_status instance-attribute

candidate_status: NotRequired[CandidateStatus]

The candidate's status.

candidate_steps instance-attribute

candidate_steps: NotRequired[CandidateSteps]

Information about the candidate's steps.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The creation time.

end_time instance-attribute

end_time: NotRequired[Timestamp]

The end time.

failure_reason instance-attribute

failure_reason: NotRequired[AutoMLFailureReason]

The failure reason.

final_auto_ml_job_objective_metric instance-attribute

final_auto_ml_job_objective_metric: NotRequired[FinalAutoMLJobObjectiveMetric]

inference_container_definitions instance-attribute

inference_container_definitions: NotRequired[AutoMLInferenceContainerDefinitions]

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.

inference_containers instance-attribute

inference_containers: NotRequired[AutoMLContainerDefinitions]

Information about the recommended inference container definitions.

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

The last modified time.

objective_status instance-attribute

objective_status: NotRequired[ObjectiveStatus]

The objective's status.