model.Model

class trains.model.Model

Represent an existing model in the system, search by model id. The Model will be read-only and can be used to pre initialize a network

Load model based on id, returned object is read-only and can be connected to a task

Notice, we can override the input model when running remotely

Parameters

model_id – id (string)

property comment

The comment for the model. Also, use for a model description.

Returns

The model comment / description.

property config_dict

The configuration as a dictionary, parsed from the design text. This usually represents the model configuration. For example, prototxt, an ini file, or Python code to evaluate.

Returns

The configuration.

property config_text

The configuration as a string. For example, prototxt, an ini file, or Python code to evaluate.

Returns

The configuration.

get_local_copy(extract_archive=True, raise_on_error=False)

Retrieve a valid link to the model file(s). If the model URL is a file system link, it will be returned directly. If the model URL is points to a remote location (http/s3/gs etc.), it will download the file(s) and return the temporary location of the downloaded model.

Parameters
  • extract_archive (bool) – If True and the model is of type ‘packaged’ (e.g. TensorFlow compressed folder) The returned path will be a temporary folder containing the archive content

  • raise_on_error (bool) – If True and the artifact could not be downloaded, raise ValueError, otherwise return None on failure and output log warning.

Returns

A local path to the model (or a downloaded copy of it).

get_weights(raise_on_error=False)

Download the base model and return the locally stored filename.

Parameters

raise_on_error (bool) – If True and the artifact could not be downloaded, raise ValueError, otherwise return None on failure and output log warning.

Returns

The locally stored file.

get_weights_package(return_path=False, raise_on_error=False)

Download the base model package into a temporary directory (extract the files), or return a list of the locally stored filenames.

Parameters
  • return_path (bool) –

    Return the model weights or a list of filenames (Optional)

    • True - Download the model weights into a temporary directory, and return the temporary directory path.

    • False - Return a list of the locally stored filenames. (Default)

  • raise_on_error (bool) – If True and the artifact could not be downloaded, raise ValueError, otherwise return None on failure and output log warning.

Returns

The model weights, or a list of the locally stored filenames.

property id

The Id (system UUID) of the model.

Returns

The model ID.

property labels

The label enumeration of string (label) to integer (value) pairs.

Returns

A dictionary containing labels enumeration, where the keys are labels and the values as integers.

property name

The name of the model.

Returns

The model name.

publish()

Set the model to the status published and for public use. If the model’s status is already published, then this method is a no-op.

property tags

A list of tags describing the model.

Returns

The list of tags.

property task

Return the creating task id (str)

Returns

The Task ID.

property url

Return the url of the model file (or archived files)

Returns

The model file URL.