Setup

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. Provide the key to your client in one of two ways. The options are listed in order of increasing precedence.

Option 1: in the configuration file at $HOME/.embedl_hub. Use the following command to add the key to your configuration, or edit the file manually.

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

Note: this will store your key in plaintext. Any existing key in the file will be overwritten. For more information about the configuration file, see Configuration.

Option 2: via an environment variable. Set and export the key for your current shell:

export EMBEDL_HUB_API_KEY=<your-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:

• Qualcomm AI Hub

Configuration

The client manages user settings in a YAML file at $HOME/.embedl_hub. This file can be edited manually to configure your API key, or set a default project or experiment name.

Example:

api_key: 'eh_...'

project: 'My Flower Detector App'

experiment: 'MobileNet Flower Detector'

Include your full API key in the api_key value, including the eh_ prefix.

Note: The EMBEDL_HUB_API_KEY environment variable takes precedence over the api_key value in the configuration file.

You can view your current configuration using the following command.

embedl-hub show