Skip to main content

Install Layer SDK

The Layer SDK is a Python module distributed on pypi. It contains Layer CLI commands for managing ML pipelines in Layer from your local machine.

Layer SDK can be installed via pip. We recommend using virtual environments when installing with pip. For more information, refer to Creation of virtual environments.

note

Layer only supports Linux and macOS systems. If you are a Windows user, we recommend using Windows Subsystem for Linux (WSL).

Layer SDK might work if you run PowerShell as an Administrator, but Layer does not guarantee support for it.

Prerequisites#

  • An internet connection
  • A Linux or macOS system to run the Layer SDK on
  • A Safari 12+ or Chrome 70+ web browser to run the Layer app
  • Python version 3.8 installed
  • pip installed

Install Layer SDK#

  1. Install the Layer SDK.
pip install layer-sdk

If you have permission problems, then try:

pip install --user layer-sdk
  1. Check your installation. In the command line, enter layer --help.

    If the Layer help is displayed, then installation was successful.

Log in to Layer#

You need to log in before running any Layer SDK commands. Enter the following command in the command line.

layer login

A browser window opens https://beta.layer.co to sign in. If you don't have a Layer account already, you can create one now.