libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMaker.CreateAlgorithm

Description

Create a machine learning algorithm that you can use in Amazon SageMaker and list in the Amazon Web Services Marketplace.

Synopsis

Creating a Request

data CreateAlgorithm Source #

See: newCreateAlgorithm smart constructor.

Constructors

CreateAlgorithm' 

Fields

  • validationSpecification :: Maybe AlgorithmValidationSpecification

    Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code.

  • inferenceSpecification :: Maybe InferenceSpecification

    Specifies details about inference jobs that the algorithm runs, including the following:

    • The Amazon ECR paths of containers that contain the inference code and model artifacts.
    • The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.
    • The input and output content formats that the algorithm supports for inference.
  • algorithmDescription :: Maybe Text

    A description of the algorithm.

  • certifyForMarketplace :: Maybe Bool

    Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.

  • tags :: Maybe [Tag]

    An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

  • algorithmName :: Text

    The name of the algorithm.

  • trainingSpecification :: TrainingSpecification

    Specifies details about training jobs run by this algorithm, including the following:

    • The Amazon ECR path of the container and the version digest of the algorithm.
    • The hyperparameters that the algorithm supports.
    • The instance types that the algorithm supports for training.
    • Whether the algorithm supports distributed training.
    • The metrics that the algorithm emits to Amazon CloudWatch.
    • Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.
    • The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

Instances

Instances details
Eq CreateAlgorithm Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

Read CreateAlgorithm Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

Show CreateAlgorithm Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

Generic CreateAlgorithm Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

Associated Types

type Rep CreateAlgorithm :: Type -> Type #

NFData CreateAlgorithm Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

Methods

rnf :: CreateAlgorithm -> () #

Hashable CreateAlgorithm Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

ToJSON CreateAlgorithm Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

AWSRequest CreateAlgorithm Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

Associated Types

type AWSResponse CreateAlgorithm #

ToHeaders CreateAlgorithm Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

ToPath CreateAlgorithm Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

ToQuery CreateAlgorithm Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

type Rep CreateAlgorithm Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

type Rep CreateAlgorithm = D1 ('MetaData "CreateAlgorithm" "Amazonka.SageMaker.CreateAlgorithm" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "CreateAlgorithm'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "validationSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlgorithmValidationSpecification)) :*: (S1 ('MetaSel ('Just "inferenceSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InferenceSpecification)) :*: S1 ('MetaSel ('Just "algorithmDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "certifyForMarketplace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "algorithmName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "trainingSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TrainingSpecification)))))
type AWSResponse CreateAlgorithm Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

newCreateAlgorithm Source #

Create a value of CreateAlgorithm with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:validationSpecification:CreateAlgorithm', createAlgorithm_validationSpecification - Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code.

$sel:inferenceSpecification:CreateAlgorithm', createAlgorithm_inferenceSpecification - Specifies details about inference jobs that the algorithm runs, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.
  • The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.
  • The input and output content formats that the algorithm supports for inference.

$sel:algorithmDescription:CreateAlgorithm', createAlgorithm_algorithmDescription - A description of the algorithm.

$sel:certifyForMarketplace:CreateAlgorithm', createAlgorithm_certifyForMarketplace - Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.

$sel:tags:CreateAlgorithm', createAlgorithm_tags - An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

$sel:algorithmName:CreateAlgorithm', createAlgorithm_algorithmName - The name of the algorithm.

$sel:trainingSpecification:CreateAlgorithm', createAlgorithm_trainingSpecification - Specifies details about training jobs run by this algorithm, including the following:

  • The Amazon ECR path of the container and the version digest of the algorithm.
  • The hyperparameters that the algorithm supports.
  • The instance types that the algorithm supports for training.
  • Whether the algorithm supports distributed training.
  • The metrics that the algorithm emits to Amazon CloudWatch.
  • Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.
  • The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

Request Lenses

createAlgorithm_validationSpecification :: Lens' CreateAlgorithm (Maybe AlgorithmValidationSpecification) Source #

Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code.

createAlgorithm_inferenceSpecification :: Lens' CreateAlgorithm (Maybe InferenceSpecification) Source #

Specifies details about inference jobs that the algorithm runs, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.
  • The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.
  • The input and output content formats that the algorithm supports for inference.

createAlgorithm_certifyForMarketplace :: Lens' CreateAlgorithm (Maybe Bool) Source #

Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.

createAlgorithm_tags :: Lens' CreateAlgorithm (Maybe [Tag]) Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

createAlgorithm_trainingSpecification :: Lens' CreateAlgorithm TrainingSpecification Source #

Specifies details about training jobs run by this algorithm, including the following:

  • The Amazon ECR path of the container and the version digest of the algorithm.
  • The hyperparameters that the algorithm supports.
  • The instance types that the algorithm supports for training.
  • Whether the algorithm supports distributed training.
  • The metrics that the algorithm emits to Amazon CloudWatch.
  • Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.
  • The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

Destructuring the Response

data CreateAlgorithmResponse Source #

See: newCreateAlgorithmResponse smart constructor.

Constructors

CreateAlgorithmResponse' 

Fields

Instances

Instances details
Eq CreateAlgorithmResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

Read CreateAlgorithmResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

Show CreateAlgorithmResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

Generic CreateAlgorithmResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

Associated Types

type Rep CreateAlgorithmResponse :: Type -> Type #

NFData CreateAlgorithmResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

Methods

rnf :: CreateAlgorithmResponse -> () #

type Rep CreateAlgorithmResponse Source # 
Instance details

Defined in Amazonka.SageMaker.CreateAlgorithm

type Rep CreateAlgorithmResponse = D1 ('MetaData "CreateAlgorithmResponse" "Amazonka.SageMaker.CreateAlgorithm" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "CreateAlgorithmResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "algorithmArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateAlgorithmResponse Source #

Create a value of CreateAlgorithmResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateAlgorithmResponse', createAlgorithmResponse_httpStatus - The response's http status code.

$sel:algorithmArn:CreateAlgorithmResponse', createAlgorithmResponse_algorithmArn - The Amazon Resource Name (ARN) of the new algorithm.

Response Lenses

createAlgorithmResponse_algorithmArn :: Lens' CreateAlgorithmResponse Text Source #

The Amazon Resource Name (ARN) of the new algorithm.