Class CustomModelTrainingParameters

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

Contains custom model training parameters. See Custom models in Neptune ML.

See Also:

  • Method Details

    • sourceS3DirectoryPath

      public final String sourceS3DirectoryPath()

      The path to the Amazon S3 location where the Python module implementing your model is located. This must point to a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a model-hpo-configuration.json file.

      Returns:
      The path to the Amazon S3 location where the Python module implementing your model is located. This must point to a valid existing Amazon S3 location that contains, at a minimum, a training script, a transform script, and a model-hpo-configuration.json file.

    • trainingEntryPointScript

      public final String trainingEntryPointScript()

      The name of the entry point in your module of a script that performs model training and takes hyperparameters as command-line arguments, including fixed hyperparameters. The default is training.py.

      Returns:
      The name of the entry point in your module of a script that performs model training and takes hyperparameters as command-line arguments, including fixed hyperparameters. The default is training.py.

    • transformEntryPointScript

      public final String transformEntryPointScript()

      The name of the entry point in your module of a script that should be run after the best model from the hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It should be able to run with no command-line arguments.The default is transform.py.

      Returns:
      The name of the entry point in your module of a script that should be run after the best model from the hyperparameter search has been identified, to compute the model artifacts necessary for model deployment. It should be able to run with no command-line arguments.The default is transform.py.

    • toBuilder

      public CustomModelTrainingParameters.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<CustomModelTrainingParameters.Builder,CustomModelTrainingParameters>
      Returns:
      a builder for type T

    • builder

      public static CustomModelTrainingParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CustomModelTrainingParameters.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.