HyperParameterSpecification ¶

class HyperParameterSpecification(TypedDict, closed=True):
    name: NotRequired["capo_sagemaker.types.parameter_name.ParameterName"]
    """<p>The name of this hyperparameter. The name must be unique.</p>"""
    description: NotRequired[
        "capo_sagemaker.types.entity_description.EntityDescription"
    ]
    """<p>A brief description of the hyperparameter.</p>"""
    type: NotRequired["capo_sagemaker.types.parameter_type.ParameterType"]
    """<p>The type of this hyperparameter. The valid types are <code>Integer</code>, <code>Continuous</code>, <code>Categorical</code>, and <code>FreeText</code>.</p>"""
    range: NotRequired["capo_sagemaker.types.parameter_range.ParameterRange"]
    """<p>The allowed range for this hyperparameter.</p>"""
    is_tunable: NotRequired["capo_sagemaker.types.boolean.Boolean"]
    """<p>Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.</p>"""
    is_required: NotRequired["capo_sagemaker.types.boolean.Boolean"]
    """<p>Indicates whether this hyperparameter is required.</p>"""
    default_value: NotRequired[
        "capo_sagemaker.types.hyper_parameter_value.HyperParameterValue"
    ]
    """<p>The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.</p>"""