Package software.amazon.awssdk.services.lookoutequipment.model

Interface ModelSummary.Builder

    • Method Detail

      • modelName

        ModelSummary.Builder modelName​(String modelName)

        The name of the machine learning model.

        Parameters:
        modelName - The name of the machine learning model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelArn

        ModelSummary.Builder modelArn​(String modelArn)

        The Amazon Resource Name (ARN) of the machine learning model.

        Parameters:
        modelArn - The Amazon Resource Name (ARN) of the machine learning model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • datasetName

        ModelSummary.Builder datasetName​(String datasetName)

        The name of the dataset being used for the machine learning model.

        Parameters:
        datasetName - The name of the dataset being used for the machine learning model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • datasetArn

        ModelSummary.Builder datasetArn​(String datasetArn)

        The Amazon Resource Name (ARN) of the dataset used to create the model.

        Parameters:
        datasetArn - The Amazon Resource Name (ARN) of the dataset used to create the model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        ModelSummary.Builder status​(String status)

        Indicates the status of the machine learning model.

        Parameters:
        status - Indicates the status of the machine learning model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelStatus, ModelStatus

      • status

        ModelSummary.Builder status​(ModelStatus status)

        Indicates the status of the machine learning model.

        Parameters:
        status - Indicates the status of the machine learning model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelStatus, ModelStatus

      • createdAt

        ModelSummary.Builder createdAt​(Instant createdAt)

        The time at which the specific model was created.

        Parameters:
        createdAt - The time at which the specific model was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • activeModelVersion

        ModelSummary.Builder activeModelVersion​(Long activeModelVersion)

        The model version that the inference scheduler uses to run an inference execution.

        Parameters:
        activeModelVersion - The model version that the inference scheduler uses to run an inference execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • activeModelVersionArn

        ModelSummary.Builder activeModelVersionArn​(String activeModelVersionArn)

        The Amazon Resource Name (ARN) of the model version that is set as active. The active model version is the model version that the inference scheduler uses to run an inference execution.

        Parameters:
        activeModelVersionArn - The Amazon Resource Name (ARN) of the model version that is set as active. The active model version is the model version that the inference scheduler uses to run an inference execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • latestScheduledRetrainingStatus

        ModelSummary.Builder latestScheduledRetrainingStatus​(String latestScheduledRetrainingStatus)

        Indicates the status of the most recent scheduled retraining run.

        Parameters:
        latestScheduledRetrainingStatus - Indicates the status of the most recent scheduled retraining run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelVersionStatus, ModelVersionStatus

      • latestScheduledRetrainingStatus

        ModelSummary.Builder latestScheduledRetrainingStatus​(ModelVersionStatus latestScheduledRetrainingStatus)

        Indicates the status of the most recent scheduled retraining run.

        Parameters:
        latestScheduledRetrainingStatus - Indicates the status of the most recent scheduled retraining run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelVersionStatus, ModelVersionStatus

      • latestScheduledRetrainingModelVersion

        ModelSummary.Builder latestScheduledRetrainingModelVersion​(Long latestScheduledRetrainingModelVersion)

        Indicates the most recent model version that was generated by retraining.

        Parameters:
        latestScheduledRetrainingModelVersion - Indicates the most recent model version that was generated by retraining.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • latestScheduledRetrainingStartTime

        ModelSummary.Builder latestScheduledRetrainingStartTime​(Instant latestScheduledRetrainingStartTime)

        Indicates the start time of the most recent scheduled retraining run.

        Parameters:
        latestScheduledRetrainingStartTime - Indicates the start time of the most recent scheduled retraining run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextScheduledRetrainingStartDate

        ModelSummary.Builder nextScheduledRetrainingStartDate​(Instant nextScheduledRetrainingStartDate)

        Indicates the date that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day.

        Parameters:
        nextScheduledRetrainingStartDate - Indicates the date that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • retrainingSchedulerStatus

        ModelSummary.Builder retrainingSchedulerStatus​(String retrainingSchedulerStatus)

        Indicates the status of the retraining scheduler.

        Parameters:
        retrainingSchedulerStatus - Indicates the status of the retraining scheduler.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RetrainingSchedulerStatus, RetrainingSchedulerStatus

      • modelDiagnosticsOutputConfiguration

        ModelSummary.Builder modelDiagnosticsOutputConfiguration​(ModelDiagnosticsOutputConfiguration modelDiagnosticsOutputConfiguration)
        Sets the value of the ModelDiagnosticsOutputConfiguration property for this object.
        Parameters:
        modelDiagnosticsOutputConfiguration - The new value for the ModelDiagnosticsOutputConfiguration property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelQuality

        ModelSummary.Builder modelQuality​(String modelQuality)

        Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

        If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

        For information about using labels with your models, see Understanding labeling.

        For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

        Parameters:
        modelQuality - Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

        If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

        For information about using labels with your models, see Understanding labeling.

        For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelQuality, ModelQuality

      • modelQuality

        ModelSummary.Builder modelQuality​(ModelQuality modelQuality)

        Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

        If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

        For information about using labels with your models, see Understanding labeling.

        For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

        Parameters:
        modelQuality - Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET.

        If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.

        For information about using labels with your models, see Understanding labeling.

        For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelQuality, ModelQuality