# typing

Python API: `hubai_sdk.typing`

Public literal types accepted by HubAI service functions.

These aliases enumerate values sent to the HubAI API. They are useful when building typed wrappers or configuration models;
ordinary callers may pass the corresponding strings directly.

 * `Important aliases:`: * [Task](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md)
   describes the problem solved by a model.
    * [License](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) contains license
      names accepted for model metadata.
    * [QuantizationMode](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) selects
      the precision and calibration strategy.
    * [QuantizationData](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) accepts
      a built-in domain or an `aid_` dataset ID.
    * [YoloVersion](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) selects the
      YOLO output decoder contract.

[Visibility](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) represents the API's
three string labels: `"public"`, `"private"`, and `"team"`. Public resource functions currently expose an `is_public` flag
instead, and the meaning of `None` depends on the operation: it creates a team-visible model, disables visibility filtering in
list operations, and leaves visibility unchanged in
[update_model](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/services/models.md).

## Module Attributes

| Name | Type | Description |
| --- | --- | --- |
| [`DatasetId`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) |  |  |
| [`HubService`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) | `TypeAlias` |
|
| [`License`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) | `TypeAlias` |  |
| [`ModelClass`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) | `TypeAlias` |
|
| [`Order`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) | `TypeAlias` |  |
| [`Quantization`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) | `TypeAlias`
| |
| [`QuantizationData`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) |
`TypeAlias` | |
| [`QuantizationMode`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) |
`TypeAlias` | |
| [`Status`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) | `TypeAlias` |  |
| [`TargetPrecision`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) |
`TypeAlias` | |
| [`Task`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) | `TypeAlias` |  |
| [`Visibility`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) | `TypeAlias` |
|
| [`YoloVersion`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md) | `TypeAlias` |
|

### variable `DatasetId`

```python
DatasetId = Annotated[str, Field(pattern='^aid_[a-zA-Z0-9_]+')]
```

### type alias `HubService`

```python
HubService: TypeAlias = Literal['models', 'dags', 'jobs']
```

### type alias `License`

```python
License: TypeAlias = Literal[
    'undefined',
    'MIT',
    'GNU General Public License v3.0',
    'GNU Affero General Public License v3.0',
    'Apache 2.0',
    'NTU S-Lab 1.0',
    'Ultralytics Enterprise',
    'CreativeML Open RAIL-M',
    'BSD 3-Clause',
]
```

### type alias `ModelClass`

```python
ModelClass: TypeAlias = Literal['base', 'exported']
```

### type alias `Order`

```python
Order: TypeAlias = Literal['asc', 'desc']
```

### type alias `Quantization`

```python
Quantization: TypeAlias = Literal[
    'DRIVING',
    'FOOD',
    'GENERAL',
    'INDOORS',
    'RANDOM',
    'WAREHOUSE',
    'CLIP',
    'CUSTOM',
    'UNKNOWN',
]
```

### type alias `QuantizationData`

```python
QuantizationData: TypeAlias = Quantization | DatasetId
```

### type alias `QuantizationMode`

```python
QuantizationMode: TypeAlias = Literal[
    'INT8_STANDARD',
    'INT8_ACCURACY_FOCUSED',
    'INT8_INT16_MIXED',
    'INT8_INT16_MIXED_ACCURACY_FOCUSED',
    'FP16_STANDARD',
    'FP32_STANDARD',
]
```

### type alias `Status`

```python
Status: TypeAlias = Literal['available', 'unavailable']
```

### type alias `TargetPrecision`

```python
TargetPrecision: TypeAlias = Literal['FP16', 'FP32', 'INT8', 'INT8_INT16']
```

### type alias `Task`

```python
Task: TypeAlias = ...
```

### type alias `Visibility`

```python
Visibility: TypeAlias = Literal['public', 'private', 'team']
```

### type alias `YoloVersion`

```python
YoloVersion: TypeAlias = ...
```
