Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

describe_algorithm

describe_algorithm(**kwargs)

Describes the given algorithm.

See also: AWS API Documentation

Request Syntax

response = client.describe_algorithm(
    algorithmArn='string'
)
Parameters
algorithmArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the algorithm to describe.

Return type
dict
Returns
Response Syntax
{
    'algorithm': {
        'name': 'string',
        'algorithmArn': 'string',
        'algorithmImage': {
            'name': 'string',
            'dockerURI': 'string'
        },
        'defaultHyperParameters': {
            'string': 'string'
        },
        'defaultHyperParameterRanges': {
            'integerHyperParameterRanges': [
                {
                    'name': 'string',
                    'minValue': 123,
                    'maxValue': 123,
                    'isTunable': True|False
                },
            ],
            'continuousHyperParameterRanges': [
                {
                    'name': 'string',
                    'minValue': 123.0,
                    'maxValue': 123.0,
                    'isTunable': True|False
                },
            ],
            'categoricalHyperParameterRanges': [
                {
                    'name': 'string',
                    'values': [
                        'string',
                    ],
                    'isTunable': True|False
                },
            ]
        },
        'defaultResourceConfig': {
            'string': 'string'
        },
        'trainingInputMode': 'string',
        'roleArn': 'string',
        'creationDateTime': datetime(2015, 1, 1),
        'lastUpdatedDateTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • algorithm (dict) --

      A listing of the properties of the algorithm.

      • name (string) --

        The name of the algorithm.

      • algorithmArn (string) --

        The Amazon Resource Name (ARN) of the algorithm.

      • algorithmImage (dict) --

        The URI of the Docker container for the algorithm image.

        • name (string) --

          The name of the algorithm image.

        • dockerURI (string) --

          The URI of the Docker container for the algorithm image.

      • defaultHyperParameters (dict) --

        Specifies the default hyperparameters.

        • (string) --
          • (string) --
      • defaultHyperParameterRanges (dict) --

        Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

        • integerHyperParameterRanges (list) --

          The integer-valued hyperparameters and their default ranges.

          • (dict) --

            Provides the name and default range of a integer-valued hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

            • name (string) --

              The name of the hyperparameter.

            • minValue (integer) --

              The minimum allowable value for the hyperparameter.

            • maxValue (integer) --

              The maximum allowable value for the hyperparameter.

            • isTunable (boolean) --

              Indicates whether the hyperparameter is tunable.

        • continuousHyperParameterRanges (list) --

          The continuous hyperparameters and their default ranges.

          • (dict) --

            Provides the name and default range of a continuous hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

            • name (string) --

              The name of the hyperparameter.

            • minValue (float) --

              The minimum allowable value for the hyperparameter.

            • maxValue (float) --

              The maximum allowable value for the hyperparameter.

            • isTunable (boolean) --

              Whether the hyperparameter is tunable.

        • categoricalHyperParameterRanges (list) --

          The categorical hyperparameters and their default ranges.

          • (dict) --

            Provides the name and default range of a categorical hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

            • name (string) --

              The name of the hyperparameter.

            • values (list) --

              A list of the categories for the hyperparameter.

              • (string) --
            • isTunable (boolean) --

              Whether the hyperparameter is tunable.

      • defaultResourceConfig (dict) --

        Specifies the default maximum number of training jobs and parallel training jobs.

        • (string) --
          • (string) --
      • trainingInputMode (string) --

        The training input mode.

      • roleArn (string) --

        The Amazon Resource Name (ARN) of the role.

      • creationDateTime (datetime) --

        The date and time (in Unix time) that the algorithm was created.

      • lastUpdatedDateTime (datetime) --

        The date and time (in Unix time) that the algorithm was last updated.

Exceptions

  • Personalize.Client.exceptions.InvalidInputException
  • Personalize.Client.exceptions.ResourceNotFoundException