Discovery

DeGirum Face API Reference. Hardware discovery helpers built on the embedded model registry.

This API Reference is based on DeGirum Face version 1.4.1.

Discovery functions for the degirum_face package

This module provides functions to discover:

1. Available hardware on different inference hosts
2. Compatible hardware (intersection of registry and system)
3. Compatible models based on hardware/task filters

Note: For registry hardware/tasks, use degirum_face.model_registry.get_hardware() and degirum_face.model_registry.get_tasks() directly.

Functions

get_compatible_hw(inference_host_address='@local')

get_compatible_hw(inference_host_address='@local')

Get hardware types that are both in the registry AND available on the system

This is the most useful function for users - it shows what hardware they can actually use.

Parameters:

Name	Type	Description	Default
inference_host_address	str	Where to check for hardware - "@local": Local system using 'degirum sys-info' - "@cloud": DeGirum cloud using degirum.get_supported_devices() - "host_ip": AI server using 'degirum sys-info --host host_ip'	'@local'

Returns:

Type	Description
List[str]	List[str]: List of hardware types that work on both registry and system

get_system_hw(inference_host_address='@local')

get_system_hw(inference_host_address='@local')

Get hardware available on a specific inference host

Parameters:

Name	Type	Description	Default
inference_host_address	str	Where to check for hardware - "@local": Local system using degirum.get_supported_devices() - "@cloud": DeGirum cloud using degirum.get_supported_devices() - "host_ip": AI server using degirum.get_supported_devices()	'@local'

Returns:

Type	Description
List[str]	List[str]: List of available hardware types (e.g., ['HAILORT/HAILO8', 'TFLITE/CPU']) Returns empty list if detection fails