[ aws . personalize ]

describe-algorithm

Description

Describes the given algorithm.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-algorithm
--algorithm-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--algorithm-arn (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

algorithm -> (structure)

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 -> (structure)

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 -> (map)

Specifies the default hyperparameters.

key -> (string)

value -> (string)

defaultHyperParameterRanges -> (structure)

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.

(structure)

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.

(structure)

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 -> (double)

The minimum allowable value for the hyperparameter.

maxValue -> (double)

The maximum allowable value for the hyperparameter.

isTunable -> (boolean)

Whether the hyperparameter is tunable.

categoricalHyperParameterRanges -> (list)

The categorical hyperparameters and their default ranges.

(structure)

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 -> (map)

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

key -> (string)

value -> (string)

trainingInputMode -> (string)

The training input mode.

roleArn -> (string)

The Amazon Resource Name (ARN) of the role.

creationDateTime -> (timestamp)

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

lastUpdatedDateTime -> (timestamp)

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