# PySDK Package {% hint style="info" %} This API Reference is based on PySDK 0.20.0. {% endhint %} ## \_LOCAL `degirum.LOCAL = ZooManager._LOCAL` `module-attribute` Local inference designator: use it as a first argument of [degirum.connect](#degirum.connect) function to specify inference on local AI hardware ## \_CLOUD `degirum.CLOUD = ZooManager._CLOUD` `module-attribute` Cloud inference designator: use it as a first argument of [degirum.connect](#degirum.connect) function to specify cloud-based inference ## connect(inference\_host\_address, ...) `degirum.connect(inference_host_address, zoo_url='', token='')` Connect to the AI inference host and model zoo of your choice. This is the main PySDK entry point: you start your work with PySDK by calling this function. The following use cases are supported: 1. You want to perform **cloud inferences** and take models from some **cloud model zoo**. 2. You want to perform inferences on some **AI server** and take models from some **cloud model zoo**. 3. You want to perform inferences on some **AI server** and take models from its **local model zoo**. 4. You want to perform inferences on **local AI hardware** and take models from some **cloud model zoo**. 5. You want to perform inferences on **local AI hardware** and take models from the **local model zoo** directory on your local drive. 6. You want to perform inferences on **local AI hardware** and use **particular model** from your local drive. Parameters: | Name | Type | Description | Default | | ------------------------ | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | `inference_host_address` | `str` |

Inference engine designator; it defines which inference engine to use.

| *required* | | `zoo_url` | `str` |

Model zoo URL string which defines the model zoo to operate with.

| `''` | | `token` | `str` |

Cloud API access token used to access the cloud zoo.

| `''` | Returns: | Type | Description | | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | | [`ZooManager`](/pysdk/user-guide-pysdk/api-ref/zoo-manager.md) | An instance of Model Zoo manager object configured to work with AI inference host and model zoo of your choice. | Once you created Model Zoo manager object, you may use the following methods: * [degirum.zoo\_manager.ZooManager.list\_models](https://docs.degirum.com/pysdk/user-guide-pysdk/api-ref/pages/YhwNF6qcgxroBmccSwg8#degirum.zoo_manager.zoomanager.list_models) to list and search models available in the model zoo. * [degirum.zoo\_manager.ZooManager.load\_model](https://docs.degirum.com/pysdk/user-guide-pysdk/api-ref/pages/YhwNF6qcgxroBmccSwg8#degirum.zoo_manager.zoomanager.load_model) to create [degirum.model.Model](https://docs.degirum.com/pysdk/user-guide-pysdk/api-ref/pages/GfBG9YuP1z73SsOm25XD#degirum.model.model) model handling object to be used for AI inferences. * [degirum.zoo\_manager.ZooManager.model\_info](https://docs.degirum.com/pysdk/user-guide-pysdk/api-ref/pages/YhwNF6qcgxroBmccSwg8#degirum.zoo_manager.zoomanager.model_info) to request model parameters. ## load\_model(model\_name, ...) `degirum.load_model(model_name, inference_host_address, zoo_url='', token='', **kwargs)` Load a model from the model zoo for the inference. Parameters: | Name | Type | Description | Default | | ------------------------ | ----- | ------------------------------------------------------------------------------------------------------ | ---------- | | `model_name` | `str` | Model name to load from the model zoo. | *required* | | `inference_host_address` | `str` | Inference engine designator; it defines which inference engine to use. | *required* | | `zoo_url` | `str` | Model zoo URL string which defines the model zoo to operate with. | `''` | | `token` | `str` | Cloud API access token used to access the cloud zoo. | `''` | | `**kwargs` | `any` | you may pass arbitrary model properties to be assigned to the model object in a form of property=value | `{}` | Note For detailed description of `zoo_url`, `inference_host_address`, and `token` parameters refer to [degirum.connect](#degirum.connect) function. Returns (degirum.model.Model): An instance of [degirum.model.Model](https://docs.degirum.com/pysdk/user-guide-pysdk/api-ref/pages/GfBG9YuP1z73SsOm25XD#degirum.model.model) model handling object to be used for AI inferences. ## list\_models(inference\_host\_address, ...) `degirum.list_models(inference_host_address, zoo_url, token='', **kwargs)` List models in the model zoo matching to specified filter values. Parameters: | Name | Type | Description | Default | | ------------------------ | ----- | ---------------------------------------------------------------------- | ---------- | | `inference_host_address` | `str` | Inference engine designator; it defines which inference engine to use. | *required* | | `zoo_url` | `str` | Model zoo URL string which defines the model zoo to operate with. | *required* | | `token` | `str` | Cloud API access token used to access the cloud zoo. | `''` | | `**kwargs` | `any` | filter parameters to narrow down the list of models. | `{}` | Note For detailed description of `zoo_url`, `inference_host_address`, and `token` parameters refer to [degirum.connect](#degirum.connect) function. For detailed description of `kwargs` parameters refer to [degirum.ZooManager.list\_models](https://docs.degirum.com/pysdk/user-guide-pysdk/api-ref/pages/YhwNF6qcgxroBmccSwg8#degirum.zoo_manager.zoomanager.list_models) method. Returns: | Type | Description | | ------------------------------------------ | --------------------------------------------------------------- | | `Union[List[str], Dict[str, ModelParams]]` | A dictionary with model names as keys and model info as values. | ## get\_supported\_devices(inference\_host\_address, ...) `degirum.get_supported_devices(inference_host_address, zoo_url='', token='')` Get runtime/device type names, which are available in the inference engine. Parameters: | Name | Type | Description | Default | | ------------------------ | ----- | ---------------------------------------------------------------------- | ---------- | | `inference_host_address` | `str` | Inference engine designator; it defines which inference engine to use. | *required* | | `zoo_url` | `str` | not used anymore, kept for backward compatibility. | `''` | | `token` | `str` | not used anymore, kept for backward compatibility. | `''` | {% hint style="info" %} For detailed description of `inference_host_address` parameter refer to [degirum.connect](#degirum.connect) function. {% endhint %} Returns: | Type | Description | | ----------- | ---------------------------------------------------------------------------------------- | | `List[str]` | list of runtime/device type names; each element is a string in a format "RUNTIME/DEVICE" | ## enable\_default\_logger(level=logging.DEBUG) `degirum.enable_default_logger(level=logging.DEBUG)` Helper function for adding a StreamHandler to the package logger. Removes any existing handlers. Useful for debugging. Parameters: | Name | Type | Description | Default | | ------- | ----- | ------------------------------------------------------------------------------ | ------- | | `level` | `int` | Logging level as defined in logging python package. defaults to logging.DEBUG. | `DEBUG` | Returns: | Type | Description | | --------------- | ------------------------------------------- | | `StreamHandler` | Returns an instance of added StreamHandler. | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.degirum.com/pysdk/user-guide-pysdk/api-ref/package.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.