Installation

Supported Environments

PySDK currently supports these operating systems, CPU architectures, and Python versions.

Supported Hardware

Below is a summary of what hardware we support, including the runtime, devices, and model binary formats.

Installation Options

Using pip install in a Virtual Environment

We recommend creating a Python virtual environment for PySDK and other DeGirum Python packages.

Open a command prompt or terminal, then follow the steps for your system below.

Windows

If Python is not installed, disable the Windows Python App Execution Alias before installing Python and PySDK. Ensure the Visual C++ Redistributable for Visual Studio 2015 or later is installed.

Disabling the Windows Python App Execution Alias and Installing Python on Windows

1. Locate the Alias: By default, Windows will overwrite python with Python from the Microsoft Store when entered in a terminal. Search for App Execution Alias in Windows Settings and disable both python.exe and python3.exe aliases.

1. Install a Python version supported by PySDK: After disabling the App Execution Alias, install Python from the official Python website or with winget. When installing with winget, include both Python.Python.<version> and Python.Launcher.

Installing PySDK in a Python Virtual Environment on Windows

Ensure a supported Python version is installed, then watch the video or follow the steps below:

1

Create a Python Virtual Environment

Use this command to create a virtual environment:

Copy

python -m venv <virtual-environment-name>

If you have Python Launcher and multiple Python versions installed, create the virtual environment with py and specify the version:

Copy

py <your-python-version> -m venv <virtual-environment-name>

2

Activate the Python Virtual Environment

After creating the environment with venv, navigate to the Scripts folder in your virtual environment.

Copy

cd <virtual-environment-name>\Scripts

Once in that folder, run the activation command.

On cmd.exe:

Copy

activate

On pwsh.exe:

Copy

.\Activate.ps1

After activation, the virtual environment name appears before the terminal prompt.

3

Install PySDK with pip install

With the environment active, use pip to install PySDK and optionally degirum-tools. The PySDK package is degirum, while degirum-tools helps you build AI applications with PySDK.

To install only PySDK:

Copy

pip install degirum

To install both PySDK and degirum-tools:

Copy

pip install degirum degirum-tools

4

Verify PySDK Installation

Run this command in the active virtual environment:

Copy

degirum sys-info

A list of detected devices confirms that PySDK is installed.

Linux

Ensure a Python version supported by PySDK is installed.

sudo apt-get update
sudo apt-get install python<release-number>

sudo dnf install python<release-number>

1

Create a Python Virtual Environment

Use this command to create a virtual environment:

Verify that python3 points to a supported version with python3 --version, then create the environment:

Copy

python3 -m venv <virtual-environment-name>

If you have multiple Python versions installed, you can specify a Python release version to create the virtual environment:

Copy

python<python-version> -m venv <virtual-environment-name>

2

Activate the Python Virtual Environment

After creating the environment with venv, activate it by running source <virtual-environment-folder>/bin/activate.

Copy

source <virtual-environment-folder>/bin/activate

After activation, the virtual environment name appears before the terminal prompt.

3

Install PySDK with pip install

With the environment active, use pip to install PySDK and optionally degirum-tools. The PySDK package is degirum, while degirum-tools helps you build AI applications with PySDK.

To install only PySDK:

Copy

pip install degirum

To install both PySDK and degirum-tools:

Copy

pip install degirum degirum-tools

Docker Images

We also provide Docker images for the DeGirum AI server and PySDK AI client installations.

Follow this GitHub link to DeGirum Docker repo for details on how to run these images and for corresponding source Dockerfiles.

Runtimes and Drivers

We support multiple hardware options and runtime environments. PySDK comes with support for N2X and TFLite runtimes. Follow this link for more details.

Limiting Runtime Plugin Loading

PySDK searches for runtime plugins at startup. To restrict which plugins load, set the DG_PLUGINS_ALLOWED environment variable to a list of plugin prefixes separated by any non alphanumeric character. For example:

export DG_PLUGINS_ALLOWED=n2x_runtime_agent;onnx_runtime_agent

Only plugins with prefixes in the list load when DG_PLUGINS_ALLOWED is set. If the variable is not defined, all available plugins load as before.

Supported plugin prefixes include n2x_runtime_agent, onnx_runtime_agent,hailort_runtime_agent, tflite_runtime_agent, openvino_runtime_agent,tensorrt_runtime_agent, rknn_runtime_agent, memryxrt_runtime_agent, andakida_runtime_agent.

Verification

After installing the required runtimes and device drivers, verify that PySDK can access them by running this command:

degirum sys-info

The output lists the devices available to PySDK with relevant information.

Devices:
<other device types>
    <runtime>/<device type>:
    - '@Index': 0
      <device dependent information, optional>
    - '@Index': 1
      <device dependent information, optional>
      <other devices>
    <other device types>

Troubleshooting

If you encounter errors such as:

ERROR: Could not find a version that satisfies the requirement degirum
ERROR: No matching distribution found for degirum

Create a new virtual environment and reinstall PySDK.

You can also try upgrading pip with this command:

python3 -m pip install -U pip

On Windows, confirm that the Visual C++ Redistributable for Visual Studio 2015 or later is installed.