get_model {azuremlsdk}

Get a registered model

Description

Returns a Model object for an existing model that has been previously registered to the given workspace.

Usage

get_model(
  workspace,
  name = NULL,
  id = NULL,
  tags = NULL,
  properties = NULL,
  version = NULL,
  run_id = NULL
)

Arguments

workspace

The Workspace object.

name

Retrieve the latest model with the corresponding name (a string), if it exists.

id

Retrieve the model with the corresponding ID (a string), if it exists.

tags

(Optional) Retrieve the model filtered based on the provided tags (a list), searching by either 'key' or 'list(key, value)'.

properties

(Optional) Retrieve the model filter based on the provided properties (a list), searching by either 'key' or 'list(key, value)'.

version

(Optional) An int of the version of a model to retrieve, when provided along with name. The specific version of the specified named model will be returned, if it exists.

run_id

(Optional) Retrieve the model filterd by the provided run ID (a string) the model was registered from, if it exists.

Value

The Model object.