Skip to main content
Documentation
Documentation

Setup

Get started with Embedl Hub.

Create an Embedl Hub account

To get started with Embedl Hub, you’ll first need to create a free account. After you’ve signed up, we invite you to join our Slack community. Although joining the community isn’t required, we’d love to meet you and learn what excites you about efficient edge AI.

Install the Python library

With the Embedl Hub Python library, you can quantize, compile, and profile models on real edge devices in the cloud. The library logs metrics and parameters, allowing you to analyze your results on the Embedl Hub website and to reproduce them later.

The simplest way to install the library is through pip:

pip install embedl-hub

Configure an API key

The Embedl Hub Python library requires an API key for authentication. To start, create one under Personal API keys on your profile page.

You can configure the API key using the embedl-hub CLI or by storing the key as an environment variable. A key provided as an environment variable takes precedence over a key provided using the CLI.

Using the CLI

Run the following command to configure your key using the CLI:

embedl-hub auth --api-key <your-key>

Your key will be stored in the plaintext configuration file at ~/.config/embedl-hub/config.yaml, and any existing key in the file will be overwritten.

If you prefer, you can set your API key by manually editing the configuration file:

api_key: 'eh_...'

Be sure to specify your full API key, including the eh_ prefix.

You can review the context of the configuration file with the following command:

embedl-hub show

Using an environment variable

Run the following command to configure your key using an environment variable:

export EMBEDL_HUB_API_KEY=<your-key>

The API key stored in EMBEDL_HUB_API_KEY takes precedence over the key configured using the CLI. If you originally set up your API key using an environment variable and would now like to set up a key using the CLI, be sure to unassign the environment variable first:

unset EMBEDL_HUB_API_KEY

Set up a remote hardware cloud

Embedl Hub enables you to evaluate your models on real edge AI devices without needing physical access to the devices. Follow the cloud-specific setup instructions to use remote devices: