Class SampleConfig

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

The configuration for generating text samples from the model.

See Also:

  • Method Details

    • prompt

      public final ModelInput prompt()

      The input prompt to send to the model for text generation.

      Returns:
      The input prompt to send to the model for text generation.

    • numSamples

      public final Integer numSamples()

      The number of independent samples to generate for the prompt.

      Returns:
      The number of independent samples to generate for the prompt.

    • samplingParams

      public final SamplingParams samplingParams()

      The parameters controlling the sampling strategy.

      Returns:
      The parameters controlling the sampling strategy.

    • includePromptLogprobs

      public final Boolean includePromptLogprobs()

      Specifies whether to include per-token log-probabilities for the input prompt in the response.

      Returns:
      Specifies whether to include per-token log-probabilities for the input prompt in the response.

    • topkPromptLogprobs

      public final Integer topkPromptLogprobs()

      The number of top-k log-probabilities to return per prompt token.

      Returns:
      The number of top-k log-probabilities to return per prompt token.

    • modelPackageArn

      public final String modelPackageArn()

      The ARN of the model package whose checkpoint this sample should run against. Must be a valid SageMaker model package ARN in the format arn:aws:sagemaker:REGION:ACCOUNT:model-package/PACKAGE_NAME/VERSION. When absent, the sample runs against the session's latest checkpoint.

      Returns:
      The ARN of the model package whose checkpoint this sample should run against. Must be a valid SageMaker model package ARN in the format arn:aws:sagemaker:REGION:ACCOUNT:model-package/PACKAGE_NAME/VERSION. When absent, the sample runs against the session's latest checkpoint.

    • toBuilder

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

    • builder

      public static SampleConfig.Builder builder()

    • serializableBuilderClass

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