Installation

Follow comprehensive installation guides for PySDK, covering virtual environments, Docker images, and hardware verification to launch your AI projects.

Supported Environments

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

Operating System	Supported CPU Architectures	Supported Python Versions
Ubuntu Linux 20.04, 22.04, 24.04	x86-64	3.9 ... 3.12
Ubuntu Linux 20.04, 22.04, 24.04	ARM AArch64	3.9 ... 3.12
Raspberry Pi OS (64 bit)	ARM AArch64	3.9
Windows 10/11	x86-64	3.9 ... 3.12
macOS 12	ARM AArch64	3.9

Supported Hardware

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

Vendor	Runtime	Devices	Model Binary Format
Hailo	HAILORT	HAILO8, HAILO8L	.hef
Google	TFLITE	EDGETPU	.tflite
Intel	OPENVINO	CPU, GPU, NPU	.onnx, .bin & .xml
BrainChip	AKIDA	NSoC_v2, AKD1500	.bin
DeGirum	N2X	ORCA1	.n2x
Rockchip	RKNN	RK3588, RK3568, RK3566	.rknn
MemryX	MEMRYX	MX3	.dfp
AMD	ONNX	VITIS_NPU	.onnx
NVIDIA	TENSORRT	DLA, GPU	.onnx

Installation Options

1

Using pip in a Virtual Environment

We recommend installing PySDK in a virtual environment.

To install PySDK from PyPI.org, activate the Python virtual environment and run this command:

python3 -m pip install degirum

2

Docker Images

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

Please 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.

Verification

After installing required runtimes and any needed device drivers, you can verify PySDK access to the runtimes and the devices by running this command in a terminal:

degirum sys-info

The output should contain all the devices available to PySDK and some information about them.

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

Try upgrading the pip package with the following command:

python3 -m pip install -U pip

Additionally, on Windows, ensure you have installed the Visual C++ Redistributable for Visual Studio 2015 and above.