Package software.amazon.awssdk.services.cleanroomsml.model

Interface CreateTrainedModelRequest.Builder

    • Method Detail

      • membershipIdentifier

        CreateTrainedModelRequest.Builder membershipIdentifier​(String membershipIdentifier)

        The membership ID of the member that is creating the trained model.

        Parameters:
        membershipIdentifier - The membership ID of the member that is creating the trained model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        CreateTrainedModelRequest.Builder name​(String name)

        The name of the trained model.

        Parameters:
        name - The name of the trained model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • configuredModelAlgorithmAssociationArn

        CreateTrainedModelRequest.Builder configuredModelAlgorithmAssociationArn​(String configuredModelAlgorithmAssociationArn)

        The associated configured model algorithm used to train this model.

        Parameters:
        configuredModelAlgorithmAssociationArn - The associated configured model algorithm used to train this model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hyperparameters

        CreateTrainedModelRequest.Builder hyperparameters​(Map<String,​String> hyperparameters)

        Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process.

        Parameters:
        hyperparameters - Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environment

        CreateTrainedModelRequest.Builder environment​(Map<String,​String> environment)

        The environment variables to set in the Docker container.

        Parameters:
        environment - The environment variables to set in the Docker container.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceConfig

        CreateTrainedModelRequest.Builder resourceConfig​(ResourceConfig resourceConfig)

        Information about the EC2 resources that are used to train this model.

        Parameters:
        resourceConfig - Information about the EC2 resources that are used to train this model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stoppingCondition

        CreateTrainedModelRequest.Builder stoppingCondition​(StoppingCondition stoppingCondition)

        The criteria that is used to stop model training.

        Parameters:
        stoppingCondition - The criteria that is used to stop model training.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataChannels

        CreateTrainedModelRequest.Builder dataChannels​(Collection<ModelTrainingDataChannel> dataChannels)

        Defines the data channels that are used as input for the trained model request.

        Parameters:
        dataChannels - Defines the data channels that are used as input for the trained model request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataChannels

        CreateTrainedModelRequest.Builder dataChannels​(ModelTrainingDataChannel... dataChannels)

        Defines the data channels that are used as input for the trained model request.

        Parameters:
        dataChannels - Defines the data channels that are used as input for the trained model request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateTrainedModelRequest.Builder description​(String description)

        The description of the trained model.

        Parameters:
        description - The description of the trained model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyArn

        CreateTrainedModelRequest.Builder kmsKeyArn​(String kmsKeyArn)

        The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.

        Parameters:
        kmsKeyArn - The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateTrainedModelRequest.Builder tags​(Map<String,​String> tags)

        The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

        The following basic restrictions apply to tags:

        • Maximum number of tags per resource - 50.

        • For each resource, each tag key must be unique, and each tag key can have only one value.

        • Maximum key length - 128 Unicode characters in UTF-8.

        • Maximum value length - 256 Unicode characters in UTF-8.

        • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

        • Tag keys and values are case sensitive.

        • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

        Parameters:
        tags - The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

        The following basic restrictions apply to tags:

        • Maximum number of tags per resource - 50.

        • For each resource, each tag key must be unique, and each tag key can have only one value.

        • Maximum key length - 128 Unicode characters in UTF-8.

        • Maximum value length - 256 Unicode characters in UTF-8.

        • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

        • Tag keys and values are case sensitive.

        • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

        Returns:
        Returns a reference to this object so that method calls can be chained together.