migration.md

Migration steps from cortex-client to cortex-python

The cortex-python library and its optional add-ons are replacing the cortex-client library. The new libraries are more lightweight and use-case focussed. Cortex-python may be used for development with or without the add-ons.

Uninstall the previous library (cortex-client)

To use the new Cortex libraries, cortex-python and cortex-python-builders you must uninstall the cortex-client library; cortex-client and cortex-pythoncannot be installed simultaneously in your python environment.

  > pip uninstall cortex-client

Install cortex-python

To install:

  > pip install cortex-python

To install the optional components:

  > pip install cortex-python[viz]
  > pip install cortex-python[jupyter]
  > pip install cortex-python[builders]

Import Client functionalities

The way Client functionalities can be imported has changed.

To import cortex :

> import cortex

To import ConnectionClient :

> from cortex.connection import ConnectionClient

Upload to Managed Content

Use ManagedContentClient to upload and download to your account's managed content. In cortex-client, ConnectionClient was used for these functionalities. The methods to upload and download remain the same.

To import ManagedContentClient:

> from cortex.content import ManagedContentClient

ConnectionClient can be used to save and retrieve connections.

Use Cortex magics

Cortex magics can be used only when the optional builders dependency is installed:

> %reload_ext cortex_builders

Deprecations and Removals from cortex-client

1. The InputMessage and OutputMessage classes have been deprecated. Instead, use the Message class:

> from cortex.message import Message

2. ModelClient, ModelProcess, and ModelRouter have been deprecated. Instead, use the experiment API in the Client class to run experiments, save and retrieve your models.

3. JobsClient has been deprecated. Instead, use the action API in Client class to save or retrieve actions. Also, you can use the action in the builder class inside client class to build your actions. (Can be used only when optional dependency of builders is installed)

4. SecretsClient has been deprecated. There is no equivalent replacement functionality in the python library, but you can manage secrets through the Cortex Vault in the Cortex Console or via the CLI cortex variables [command] [options].

5. Message.with_payload() has been removed. This method was previously deprecated in cortex-client v5.5.4. Instead, use the Client.message() method:

> from cortex.client import Cortex

> cortex = Cortex.client()
> message = cortex.message(payload={'value': 'hello world'})

6. LocalExperiment.set_pipeline() has been removed. This method was previously deprecated in cortex-client v5.5.0. There is no replacement method for this functionality.