software.amazon.awssdk.services.sagemaker.model

Class InputConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.InputConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InputConfig.Builder,InputConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class InputConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InputConfig.Builder,InputConfig>

Contains information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InputConfig.Builder

Method Summary

Modifier and Type	Method and Description
static InputConfig.Builder	builder()
String	dataInputConfig() Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form.
boolean	equals(Object obj)
Framework	framework() Identifies the framework in which the model was trained.
String	frameworkAsString() Identifies the framework in which the model was trained.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	s3Uri() The S3 path where the model artifacts, which result from model training, are stored.
List<SdkField<?>>	sdkFields()
static Class<? extends InputConfig.Builder>	serializableBuilderClass()
InputConfig.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

s3Uri

public String s3Uri()

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

Returns:

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

dataInputConfig

public String dataInputConfig()

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.

• TENSORFLOW, MXNET and ONNX: You must specify the name and shape of the expected data inputs in order using a dictionary format for your trained model.

  • Example of one input: {‘data’:[1,3,1024,1024]}}

  • Example for two inputs: {‘var1’: [1,1,28,28], ‘var2’:[1,1,28,28]}

• PYTORCH: You can either specify the name and shape of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format.

  • Example of one input in dictionary format: {‘input0’:[1,3,224,234]}

  • Example of one input in list format: [1,3,224,224]

  • Example of two inputs in dictionary format: {‘input0’:[1,3,224,234], 'input1':[1,3,224,224]}

  • Example of two inputs in list format: [[1,3,224,224], [1,3,224,224]]

• XGBOOST: input data name and shape are not needed.

Returns:

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.

• TENSORFLOW, MXNET and ONNX: You must specify the name and shape of the expected data inputs in order using a dictionary format for your trained model.

  • Example of one input: {‘data’:[1,3,1024,1024]}}

  • Example for two inputs: {‘var1’: [1,1,28,28], ‘var2’:[1,1,28,28]}

• PYTORCH: You can either specify the name and shape of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format.

  • Example of one input in dictionary format: {‘input0’:[1,3,224,234]}

  • Example of one input in list format: [1,3,224,224]

  • Example of two inputs in dictionary format: {‘input0’:[1,3,224,234], 'input1':[1,3,224,224]}

  • Example of two inputs in list format: [[1,3,224,224], [1,3,224,224]]

• XGBOOST: input data name and shape are not needed.

framework

public Framework framework()

Identifies the framework in which the model was trained. For example: TENSORFLOW.

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

Returns:

Identifies the framework in which the model was trained. For example: TENSORFLOW.

See Also:

Framework

frameworkAsString

public String frameworkAsString()

Identifies the framework in which the model was trained. For example: TENSORFLOW.

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

Returns:

Identifies the framework in which the model was trained. For example: TENSORFLOW.

See Also:

Framework

toBuilder

public InputConfig.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<InputConfig.Builder,InputConfig>

Returns:

a builder for type T

builder

public static InputConfig.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

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