Package software.amazon.awssdk.services.sagemaker.model

Class TrainingJobDefinition

    • Method Detail

      • trainingInputModeAsString

        public final String trainingInputModeAsString()
        Returns the value of the TrainingInputMode property for this object.

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

        Returns:
        The value of the TrainingInputMode property for this object.
        See Also:
        TrainingInputMode

      • hasHyperParameters

        public final boolean hasHyperParameters()
        For responses, this returns true if the service returned a value for the HyperParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • hyperParameters

        public final Map<String,​String> hyperParameters()

        The hyperparameters used for the training job.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHyperParameters() method.

        Returns:
        The hyperparameters used for the training job.

      • hasInputDataConfig

        public final boolean hasInputDataConfig()
        For responses, this returns true if the service returned a value for the InputDataConfig property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • inputDataConfig

        public final List<Channel> inputDataConfig()

        An array of Channel objects, each of which specifies an input source.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInputDataConfig() method.

        Returns:
        An array of Channel objects, each of which specifies an input source.

      • outputDataConfig

        public final OutputDataConfig outputDataConfig()

        the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

        Returns:
        the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

      • resourceConfig

        public final ResourceConfig resourceConfig()

        The resources, including the ML compute instances and ML storage volumes, to use for model training.

        Returns:
        The resources, including the ML compute instances and ML storage volumes, to use for model training.

      • stoppingCondition

        public final StoppingCondition stoppingCondition()

        Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

        To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

        Returns:
        Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

        To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

      • hashCode

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

      • equals

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

      • 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)