# hub

Python API: `hubai_sdk.utils.hub`

## Functions

| Name | Description |
| --- | --- |
| [`get_configs`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) | Sets up
the configuration. |
| [`get_output_dir_name`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) |
Build an output directory path for a conversion result. |
| [`get_resource_id`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) |
Resolve a UUID, HubAI ID, raw slug, or resource path to a resource ID. |
| [`get_resource_info`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) |
Fetch raw HubAI resource data for a resolved identifier. |
|
[`get_target_specific_options`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md)
| Build export options for a target from a parsed config. |
| [`get_variant_name`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) |
Derive a variant name, appending input resolution when known. |
| [`get_version_number`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) |
Return the next patch version for a model's variants. |
| [`init_dirs`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) | Create the
SDK working directories if they do not exist. |
| [`is_hubai_id`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) | Return
whether an identifier looks like a HubAI resource ID. |
| [`is_valid_uuid`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) | Return
whether a string is a valid UUID. |
| [`print_hub_ls`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) | Render a
list of HubAI resources as a rich table. |
| [`print_hub_resource_info`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md)
| Render a single HubAI resource in CLI-friendly rich output. |
| [`raise_for_hub_error`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) |
Translate a requests HTTP error into an SDK-specific exception. |
| [`resolve_resource_id`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) |
Resolve an identifier and translate lookup failures to SDK errors. |
| [`run_cli`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) | Run a CLI
action and convert SDK exceptions into clean exits. |
| [`slug_to_id`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) | Resolve a
raw resource slug to its resource ID. |
| [`wait_for_job`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) | Poll a
HubAI job until it completes or fails. |

### function `get_configs`

```python
def get_configs(
    path: str | None,
    opts: list[str] | dict[str, Any] | None = None,
) -> tuple[Config, NNArchiveConfig | None, str | None]
```

Sets up the configuration.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `path` | `str | None` | Path to the configuration file or NN Archive. | required |
| `opts` | `list[str] | dict[str, Any] | None` | Optional CLI overrides for the config file. | `None` |

Returns

| Type | Description |
| --- | --- |
| `tuple[Config, NNArchiveConfig | None, str | None]` | The parsed modelconverter configuration, optional NN Archive
configuration, and main stage key. |

### function `get_output_dir_name`

```python
def get_output_dir_name(target: Target, name: str, output_dir: str | None) -> Path
```

Build an output directory path for a conversion result.

### function `get_resource_id`

```python
def get_resource_id(
    identifier: str,
    endpoint: Literal['models', 'modelVersions', 'modelInstances'],
) -> str
```

Resolve a UUID, HubAI ID, raw slug, or resource path to a resource ID.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `identifier` | `str` | User-supplied UUID, HubAI ID, raw slug, or resource path. | required |
| `endpoint` | `Literal['models', 'modelVersions', 'modelInstances']` | Resource endpoint to resolve against. | required |

Returns

| Type | Description |
| --- | --- |
| `str` | The resolved HubAI resource ID. |

Raises

| Type | Description |
| --- | --- |
| `ResourceAmbiguousError` | If the identifier matches multiple resources. |
| `ValueError` | If the identifier cannot be resolved. |

### function `get_resource_info`

```python
def get_resource_info(identifier: str, endpoint: ResourceEndpoint) -> dict[str, Any]
```

Fetch raw HubAI resource data for a resolved identifier.

### function `get_target_specific_options`

```python
def get_target_specific_options(
    target: Target,
    cfg: SingleStageConfig,
    tool_version: str | None = None,
) -> dict[str, Any]
```

Build export options for a target from a parsed config.

### function `get_variant_name`

```python
def get_variant_name(cfg: SingleStageConfig, model_type: ModelType, name: str) -> str
```

Derive a variant name, appending input resolution when known.

### function `get_version_number`

```python
def get_version_number(model_id: str) -> str
```

Return the next patch version for a model's variants.

### function `init_dirs`

```python
def init_dirs()
```

Create the SDK working directories if they do not exist.

### function `is_hubai_id`

```python
def is_hubai_id(identifier: str) -> bool
```

Return whether an identifier looks like a HubAI resource ID.

### function `is_valid_uuid`

```python
def is_valid_uuid(uuid_string: str) -> bool
```

Return whether a string is a valid UUID.

### function `print_hub_ls`

```python
def print_hub_ls(
    data: list[dict[str, Any]],
    keys: list[str],
    rename: dict[str, str] | None = None,
)
```

Render a list of HubAI resources as a rich table.

### function `print_hub_resource_info`

```python
def print_hub_resource_info(
    model: dict[str, Any],
    keys: list[str],
    json: bool,
    rename: dict[str, str] | None = None,
    **kwargs,
)
```

Render a single HubAI resource in CLI-friendly rich output.

### function `raise_for_hub_error`

```python
def raise_for_hub_error(
    exc: HTTPError,
    *,
    identifier: str | None = None,
    endpoint: ResourceEndpoint | Literal['jobs'] | None = None,
    conflict_message: str | None = None,
) -> NoReturn
```

Translate a requests HTTP error into an SDK-specific exception.

### function `resolve_resource_id`

```python
def resolve_resource_id(identifier: str, endpoint: ResourceEndpoint) -> str
```

Resolve an identifier and translate lookup failures to SDK errors.

### function `run_cli`

```python
def run_cli(action: Callable[[], T]) -> T
```

Run a CLI action and convert SDK exceptions into clean exits.

### function `slug_to_id`

```python
def slug_to_id(
    slug: str,
    endpoint: Literal['models', 'modelVersions', 'modelInstances'],
) -> str | None
```

Resolve a raw resource slug to its resource ID.

### function `wait_for_job`

```python
def wait_for_job(job_id: str) -> JobMessageResponse
```

Poll a HubAI job until it completes or fails.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `job_id` | `str` | HubAI job ID. | required |

Returns

| Type | Description |
| --- | --- |
| `JobMessageResponse` | The completed job response. |

Raises

| Type | Description |
| --- | --- |
| `HubApiError` | If the job fails or ends in a terminal non-success status. |

## Module Attributes

| Name | Description |
| --- | --- |
| [`ResourceEndpoint`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) |  |
| [`T`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hub.md) |  |

### type alias `ResourceEndpoint`

```python
ResourceEndpoint = Literal['models', 'modelVersions', 'modelInstances']
```

### type variable `T`

```python
T = TypeVar('T')
```
