Class ModelSummary

java.lang.Object
software.amazon.awssdk.services.lookoutequipment.model.ModelSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ModelSummary.Builder,ModelSummary>
@Generated("software.amazon.awssdk:codegen") public final class ModelSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ModelSummary.Builder,ModelSummary>

Provides information about the specified machine learning model, including dataset and model names and ARNs, as well as status.

See Also:

  • Method Details

    • modelName

      public final String modelName()

      The name of the machine learning model.

      Returns:
      The name of the machine learning model.

    • modelArn

      public final String modelArn()

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

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

    • datasetName

      public final String datasetName()

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

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

    • datasetArn

      public final String datasetArn()

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

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

    • status

      public final ModelStatus status()

      Indicates the status of the machine learning model.

      If the service returns an enum value that is not available in the current SDK version, status will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Indicates the status of the machine learning model.
      See Also:

    • statusAsString

      public final String statusAsString()

      Indicates the status of the machine learning model.

      If the service returns an enum value that is not available in the current SDK version, status will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      Indicates the status of the machine learning model.
      See Also:

    • createdAt

      public final Instant createdAt()

      The time at which the specific model was created.

      Returns:
      The time at which the specific model was created.

    • activeModelVersion

      public final Long activeModelVersion()

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

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

    • activeModelVersionArn

      public final 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.

      Returns:
      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.

    • latestScheduledRetrainingStatus

      public final ModelVersionStatus latestScheduledRetrainingStatus()

      Indicates the status of the most recent scheduled retraining run.

      If the service returns an enum value that is not available in the current SDK version, latestScheduledRetrainingStatus will return ModelVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from latestScheduledRetrainingStatusAsString().

      Returns:
      Indicates the status of the most recent scheduled retraining run.
      See Also:

    • latestScheduledRetrainingStatusAsString

      public final String latestScheduledRetrainingStatusAsString()

      Indicates the status of the most recent scheduled retraining run.

      If the service returns an enum value that is not available in the current SDK version, latestScheduledRetrainingStatus will return ModelVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from latestScheduledRetrainingStatusAsString().

      Returns:
      Indicates the status of the most recent scheduled retraining run.
      See Also:

    • latestScheduledRetrainingModelVersion

      public final Long latestScheduledRetrainingModelVersion()

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

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

    • latestScheduledRetrainingStartTime

      public final Instant latestScheduledRetrainingStartTime()

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

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

    • nextScheduledRetrainingStartDate

      public final 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.

      Returns:
      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.

    • retrainingSchedulerStatus

      public final RetrainingSchedulerStatus retrainingSchedulerStatus()

      Indicates the status of the retraining scheduler.

      If the service returns an enum value that is not available in the current SDK version, retrainingSchedulerStatus will return RetrainingSchedulerStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from retrainingSchedulerStatusAsString().

      Returns:
      Indicates the status of the retraining scheduler.
      See Also:

    • retrainingSchedulerStatusAsString

      public final String retrainingSchedulerStatusAsString()

      Indicates the status of the retraining scheduler.

      If the service returns an enum value that is not available in the current SDK version, retrainingSchedulerStatus will return RetrainingSchedulerStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from retrainingSchedulerStatusAsString().

      Returns:
      Indicates the status of the retraining scheduler.
      See Also:

    • modelDiagnosticsOutputConfiguration

      public final ModelDiagnosticsOutputConfiguration modelDiagnosticsOutputConfiguration()
      Returns the value of the ModelDiagnosticsOutputConfiguration property for this object.
      Returns:
      The value of the ModelDiagnosticsOutputConfiguration property for this object.

    • modelQuality

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, modelQuality will return ModelQuality.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelQualityAsString().

      Returns:
      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.

      See Also:

    • modelQualityAsString

      public final String modelQualityAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, modelQuality will return ModelQuality.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelQualityAsString().

      Returns:
      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.

      See Also:

    • toBuilder

      public ModelSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ModelSummary.Builder,ModelSummary>
      Returns:
      a builder for type T

    • builder

      public static ModelSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModelSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.