Class: Aws::SageMakerTrainingSessionRuntime::Types::SampleConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemakertrainingsessionruntime/lib/aws-sdk-sagemakertrainingsessionruntime/types.rb

Overview

The configuration for generating text samples from the model.

See Also:

Constant Summary collapse

SENSITIVE = 
[:prompt]

Instance Attribute Summary collapse

Instance Attribute Details

#include_prompt_logprobs ⇒ Boolean

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

Returns:

  • (Boolean) 


727
728
729
730
731
732
733
734
735
736
 
# File 'gems/aws-sdk-sagemakertrainingsessionruntime/lib/aws-sdk-sagemakertrainingsessionruntime/types.rb', line 727

class SampleConfig < Struct.new(
  :prompt,
  :num_samples,
  :sampling_params,
  :include_prompt_logprobs,
  :topk_prompt_logprobs,
  :model_package_arn)
  SENSITIVE = [:prompt]
  include Aws::Structure
end

#model_package_arn ⇒ String

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:

  • (String) 


727
728
729
730
731
732
733
734
735
736
 
# File 'gems/aws-sdk-sagemakertrainingsessionruntime/lib/aws-sdk-sagemakertrainingsessionruntime/types.rb', line 727

class SampleConfig < Struct.new(
  :prompt,
  :num_samples,
  :sampling_params,
  :include_prompt_logprobs,
  :topk_prompt_logprobs,
  :model_package_arn)
  SENSITIVE = [:prompt]
  include Aws::Structure
end

#num_samples ⇒ Integer

The number of independent samples to generate for the prompt.

Returns:

  • (Integer) 


727
728
729
730
731
732
733
734
735
736
 
# File 'gems/aws-sdk-sagemakertrainingsessionruntime/lib/aws-sdk-sagemakertrainingsessionruntime/types.rb', line 727

class SampleConfig < Struct.new(
  :prompt,
  :num_samples,
  :sampling_params,
  :include_prompt_logprobs,
  :topk_prompt_logprobs,
  :model_package_arn)
  SENSITIVE = [:prompt]
  include Aws::Structure
end

#prompt ⇒ Types::ModelInput

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

Returns:



727
728
729
730
731
732
733
734
735
736
 
# File 'gems/aws-sdk-sagemakertrainingsessionruntime/lib/aws-sdk-sagemakertrainingsessionruntime/types.rb', line 727

class SampleConfig < Struct.new(
  :prompt,
  :num_samples,
  :sampling_params,
  :include_prompt_logprobs,
  :topk_prompt_logprobs,
  :model_package_arn)
  SENSITIVE = [:prompt]
  include Aws::Structure
end

#sampling_params ⇒ Types::SamplingParams

The parameters controlling the sampling strategy.

Returns:



727
728
729
730
731
732
733
734
735
736
 
# File 'gems/aws-sdk-sagemakertrainingsessionruntime/lib/aws-sdk-sagemakertrainingsessionruntime/types.rb', line 727

class SampleConfig < Struct.new(
  :prompt,
  :num_samples,
  :sampling_params,
  :include_prompt_logprobs,
  :topk_prompt_logprobs,
  :model_package_arn)
  SENSITIVE = [:prompt]
  include Aws::Structure
end

#topk_prompt_logprobs ⇒ Integer

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

Returns:

  • (Integer) 


727
728
729
730
731
732
733
734
735
736
 
# File 'gems/aws-sdk-sagemakertrainingsessionruntime/lib/aws-sdk-sagemakertrainingsessionruntime/types.rb', line 727

class SampleConfig < Struct.new(
  :prompt,
  :num_samples,
  :sampling_params,
  :include_prompt_logprobs,
  :topk_prompt_logprobs,
  :model_package_arn)
  SENSITIVE = [:prompt]
  include Aws::Structure
end