# hubai_models

Python API: `hubai_sdk.utils.hubai_models`

## Classes

| Name | Description |
| --- | --- |
|
[`ArchitecturePatchRequest`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ArchitectureRequest`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ArchitectureResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ArchiveConfigurationRequest`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ArchiveConfigurationResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`AvailableForModel`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`BodyDownloadApiV1ModelsDownloadGet`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`BodyReadAllModelInstancesApiV1ModelInstancesGet`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`BodyUploadModelInstanceFileApiV1ModelInstancesModelInstanceIdUploadPost`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`DataType`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
|
[`EnumChannelEncoding`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`EnumDomain`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
|
[`EnumHailoVersion`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`EnumIRVersion`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |
|
|
[`EnumJobStatusType`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`EnumLicenseType`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`EnumModelClass`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`EnumModelInstanceStatus`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`EnumModelPrecisionType`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`EnumModelType`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |
|
|
[`EnumPotTargetDevice`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`EnumQuantizationDataType`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`EnumQuantizationMode`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`EnumSampleSplitType`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`EnumSortOrder`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |
|
| [`EnumTaskType`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |
|
| [`EnumYoloVersion`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`GCSUploadPolicyFields`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`GCSUploadPolicyResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`GetFromSlugsRequest`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`GetFromSlugsRequestItem`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`GetFromSlugsResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`GetFromSlugsResponseItem`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`HailoExportParametersOnnxIr`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`Head`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
|
[`HeadClassificationMetadata`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`HeadMetadata`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |
|
|
[`HeadObjectDetectionMetadata`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`HeadObjectDetectionSSDMetadata`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`HeadSegmentationMetadata`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`HeadYOLOMetadata`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`HTTPValidationError`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`Input`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
|
[`InputParametersOnnxIr`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`InputType`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
|
[`JobMessageResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`JobStepResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`Metadata`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
| [`Model`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
|
[`ModelCreateRequest`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ModelDownloadResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ModelInstanceDetailsRequest`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ModelInstanceDetailsResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ModelInstanceFileResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ModelInstancePatchRequest`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ModelInstancePayloadParameters`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ModelInstanceRequest`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ModelInstanceResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ModelInstanceUploadResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`ModelLinkBase`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |
|
|
[`ModelLinkResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ModelPatchRequest`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`ModelResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |
|
|
[`ModelVersionDownloadResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ModelVersionPatchRequest`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ModelVersionPayloadParameters`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ModelVersionRequest`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`ModelVersionResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`NumberOfShaves`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`Output`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
|
[`PerformanceRating`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`PerformanceRatings`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`PreprocessingBlock`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`RVC2ExportParametersOnnxIrPresetResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`RVC3ExportParametersOnnxIr`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`RVC4ExportParametersOnnxIr`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`SnpeVersion`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) | |
|
[`TraceToggleRequest`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`UploadQuantizationZipResponse`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`ValidationError`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |

### class `ArchitecturePatchRequest`

```python
class ArchitecturePatchRequest(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `description` | `Description | None` | Description of the architecture. |
| `is_public` | `bool | None` | Flag indicating if the Architecture is public. |
| `license_type` | `EnumLicenseType | None` | Type of license. |
| `name` | `Name | None` | Name of the Architecture. |
| `performance_ratings` | `PerformanceRatings | None` | The speed and accuracy ratings for each HW with this architecture. |
| `tasks` | `list[EnumTaskType] | None` | Array of types of tasks. |
| `training_hyperparameter_config` | `dict[str, Any] | None` | The `training` configuration block parsed by the training image. |
| `training_image` | `str | None` | The internal training image used in this architecture. |
| `training_loader_config` | `dict[str, Any] | None` | Optional `loader` configuration block parsed by the training image. |
| `training_model_config` | `dict[str, Any] | None` | The `model` configuration block parsed by the training image. |

### class `ArchitectureRequest`

```python
class ArchitectureRequest(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `description` | `str` | Description of the architecture. |
| `is_public` | `bool` | Flag indicating if the Architecture is public. |
| `license_type` | `EnumLicenseType` | Type of license. |
| `name` | `str` | Name of the Architecture. |
| `performance_ratings` | `PerformanceRatings` | The speed and accuracy ratings for each HW with this architecture. |
| `tasks` | `list[EnumTaskType]` | Array of types of tasks. |
| `training_hyperparameter_config` | `dict[str, Any]` | The `training` configuration block parsed by the training image. |
| `training_image` | `str` | The internal training image used in this architecture. |
| `training_loader_config` | `dict[str, Any] | None` | Optional `loader` configuration block parsed by the training image. |
| `training_model_config` | `dict[str, Any]` | The `model` configuration block parsed by the training image. |

### class `ArchitectureResponse`

```python
class ArchitectureResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `created` | `NaiveDatetime` | Creation timestamp. |
| `description` | `str` | Description of the architecture. |
| `id` | `str` | Unique identifier. |
| `is_public` | `bool` | Flag indicating if the Architecture is public. |
| `license_type` | `EnumLicenseType` | Type of license. |
| `name` | `str` | Name of the Architecture. |
| `performance_ratings` | `PerformanceRatings` | The speed and accuracy ratings for each HW with this architecture. |
| `slug` | `str` | Slug for the Architecture. |
| `tasks` | `list[EnumTaskType]` | Array of types of tasks. |
| `team_id` | `UUID` | Hub team ID. |
| `training_hyperparameter_config` | `dict[str, Any]` | The `training` configuration block parsed by the training image. |
| `training_image` | `str` | The internal training image used in this architecture. |
| `training_loader_config` | `dict[str, Any] | None` | Optional `loader` configuration block parsed by the training image. |
| `training_model_config` | `dict[str, Any]` | The `model` configuration block parsed by the training image. |
| `updated` | `NaiveDatetime` | Last update timestamp. |
| `user_id` | `UUID` | Hub user ID. |

### class `ArchiveConfigurationRequest`

```python
class ArchiveConfigurationRequest(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `config_version` | `str | None` | String representing config schema version in format 'x.y' where x is major version and y is
minor version. |
| `model` | `Model` | A Model object representing the neural network used in the archive. |
| `model_config` |  |  |

### class `ArchiveConfigurationResponse`

```python
class ArchiveConfigurationResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `config_version` | `str | None` | String representing config schema version in format 'x.y' where x is major version and y is
minor version. |
| `model` | `Model` | A Model object representing the neural network used in the archive. |
| `model_config` |  |  |

### class `AvailableForModel`

```python
class AvailableForModel(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `id` | `str` | ID of the associated ModelInstance. |
| `platform` | `EnumModelType` | The target platform of the ModelInstance. |

### class `BodyDownloadApiV1ModelsDownloadGet`

```python
class BodyDownloadApiV1ModelsDownloadGet(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `snpe_version` | `list[str] | None` |  |
| `tags` | `list[str] | None` |  |

### class `BodyReadAllModelInstancesApiV1ModelInstancesGet`

```python
class BodyReadAllModelInstancesApiV1ModelInstancesGet(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `input_shape` | `list[str] | None` |  |
| `multiple_model_version_ids` | `list[UUID] | None` |  |
| `platforms` | `list[EnumModelType] | None` |  |
| `snpe_version` | `list[str] | None` |  |
| `tags` | `list[str] | None` |  |

### class `BodyUploadModelInstanceFileApiV1ModelInstancesModelInstanceIdUploadPost`

```python
class BodyUploadModelInstanceFileApiV1ModelInstancesModelInstanceIdUploadPost(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `files` | `list[bytes]` |  |

### class `DataType`

```python
class DataType(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `boolean` | `str` |  |
| `float16` | `str` |  |
| `float32` | `str` |  |
| `float64` | `str` |  |
| `int16` | `str` |  |
| `int32` | `str` |  |
| `int4` | `str` |  |
| `int64` | `str` |  |
| `int8` | `str` |  |
| `string` | `str` |  |
| `uint16` | `str` |  |
| `uint32` | `str` |  |
| `uint4` | `str` |  |
| `uint64` | `str` |  |
| `uint8` | `str` |  |

### class `EnumChannelEncoding`

```python
class EnumChannelEncoding(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `BGR` | `str` |  |
| `GRAY` | `str` |  |
| `NONE` | `str` |  |
| `RGB` | `str` |  |

### class `EnumDomain`

```python
class EnumDomain(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `GENERAL` | `str` |  |

### class `EnumHailoVersion`

```python
class EnumHailoVersion(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `field_2024_07` | `str` |  |
| `field_2024_10` | `str` |  |

### class `EnumIRVersion`

```python
class EnumIRVersion(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `field_2021_4_0` | `str` |  |
| `field_2022_3_0` | `str` |  |

### class `EnumJobStatusType`

```python
class EnumJobStatusType(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `CANCELLED` | `str` |  |
| `COMPLETED` | `str` |  |
| `FAILED` | `str` |  |
| `QUEUED` | `str` |  |
| `RUNNING` | `str` |  |
| `SHUTDOWN` | `str` |  |

### class `EnumLicenseType`

```python
class EnumLicenseType(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `Apache_2_0` | `str` |  |
| `BSD_3_Clause` | `str` |  |
| `CreativeML_Open_RAIL_M` | `str` |  |
| `GNU_Affero_General_Public_License_v3_0` | `str` |  |
| `GNU_General_Public_License_v3_0` | `str` |  |
| `MIT` | `str` |  |
| `NTU_S_Lab_1_0` | `str` |  |
| `Ultralytics_Enterprise` | `str` |  |
| `undefined` | `str` |  |

### class `EnumModelClass`

```python
class EnumModelClass(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `BASE` | `str` |  |
| `EXPORTED` | `str` |  |

### class `EnumModelInstanceStatus`

```python
class EnumModelInstanceStatus(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `available` | `str` |  |
| `unavailable` | `str` |  |

### class `EnumModelPrecisionType`

```python
class EnumModelPrecisionType(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `FP16` | `str` |  |
| `FP32` | `str` |  |
| `INT8` | `str` |  |
| `INT8_INT16` | `str` |  |

### class `EnumModelType`

```python
class EnumModelType(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `HAILO` | `str` |  |
| `IR` | `str` |  |
| `ONNX` | `str` |  |
| `PYTORCH` | `str` |  |
| `RVC2` | `str` |  |
| `RVC2_LEGACY` | `str` |  |
| `RVC3` | `str` |  |
| `RVC4` | `str` |  |
| `TFLITE` | `str` |  |

### class `EnumPotTargetDevice`

```python
class EnumPotTargetDevice(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `ANY` | `str` |  |
| `VPU` | `str` |  |

### class `EnumQuantizationDataType`

```python
class EnumQuantizationDataType(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `CLIP` | `str` |  |
| `CUSTOM` | `str` |  |
| `DRIVING` | `str` |  |
| `FOOD` | `str` |  |
| `GENERAL` | `str` |  |
| `INDOORS` | `str` |  |
| `RANDOM` | `str` |  |
| `UNKNOWN` | `str` |  |
| `WAREHOUSE` | `str` |  |

### class `EnumQuantizationMode`

```python
class EnumQuantizationMode(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `FP16_STANDARD` | `str` |  |
| `FP32_STANDARD` | `str` |  |
| `INT8_ACCURACY_FOCUSED` | `str` |  |
| `INT8_INT16_MIXED` | `str` |  |
| `INT8_INT16_MIXED_ACCURACY_FOCUSED` | `str` |  |
| `INT8_STANDARD` | `str` |  |

### class `EnumSampleSplitType`

```python
class EnumSampleSplitType(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `TEST` | `str` |  |
| `TRAIN` | `str` |  |
| `VAL` | `str` |  |

### class `EnumSortOrder`

```python
class EnumSortOrder(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `asc` | `str` |  |
| `desc` | `str` |  |

### class `EnumTaskType`

```python
class EnumTaskType(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `CLASSIFICATION` | `str` |  |
| `DENOISING` | `str` |  |
| `DEPTH_ESTIMATION` | `str` |  |
| `FEATURE_DETECTION` | `str` |  |
| `IMAGE_EMBEDDING` | `str` |  |
| `INSTANCE_SEGMENTATION` | `str` |  |
| `KEYPOINT_DETECTION` | `str` |  |
| `LINE_DETECTION` | `str` |  |
| `LOW_LIGHT_ENHANCEMENT` | `str` |  |
| `OBJECT_DETECTION` | `str` |  |
| `OPTICAL_CHARACTER_RECOGNITION` | `str` |  |
| `REGRESSION` | `str` |  |
| `SEGMENTATION` | `str` |  |
| `SPEECH_RECOGNITION` | `str` |  |
| `SUPER_RESOLUTION` | `str` |  |

### class `EnumYoloVersion`

```python
class EnumYoloVersion(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `goldyolo` | `str` |  |
| `yolov10` | `str` |  |
| `yolov11` | `str` |  |
| `yolov12` | `str` |  |
| `yolov26` | `str` |  |
| `yolov5` | `str` |  |
| `yolov6r1` | `str` |  |
| `yolov6r3` | `str` |  |
| `yolov6r4` | `str` |  |
| `yolov7` | `str` |  |
| `yolov8` | `str` |  |
| `yolov9` | `str` |  |

### class `GCSUploadPolicyFields`

```python
class GCSUploadPolicyFields(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `key` | `str` |  |
| `policy` | `str` |  |
| `success_action_status` | `str` |  |
| `x_goog_algorithm` | `str` |  |
| `x_goog_credential` | `str` |  |
| `x_goog_date` | `str` |  |
| `x_goog_signature` | `str` |  |

### class `GCSUploadPolicyResponse`

```python
class GCSUploadPolicyResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `fields` | `GCSUploadPolicyFields` |  |
| `url` | `str` |  |

### class `GetFromSlugsRequest`

```python
class GetFromSlugsRequest(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `items` | `list[GetFromSlugsRequestItem]` | List of slugs to get models from. |
| `model_slugs` | `list[str] | None` |  |
| `team_slugs` | `list[str] | None` |  |
| `variant_slugs` | `list[str] | None` |  |

### class `GetFromSlugsRequestItem`

```python
class GetFromSlugsRequestItem(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `identifier` | `int` | Identifier of the information. |
| `slug` | `str` | Slug to get. |

### class `GetFromSlugsResponse`

```python
class GetFromSlugsResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `items` | `list[GetFromSlugsResponseItem]` | List of model and variant information corresponding to slugs. |

### class `GetFromSlugsResponseItem`

```python
class GetFromSlugsResponseItem(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `identifier` | `int` | Identifier of the information. |
| `model` | `ModelResponse` | Model resource. |
| `model_version` | `ModelVersionResponse` | Model version/variant resource. |

### class `HailoExportParametersOnnxIr`

```python
class HailoExportParametersOnnxIr(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `alls` | `list[str] | None` | Text representation of the Hailo alls file. |
| `batch_size` | `int | None` | Batch size for Hailo. |
| `compression_level` | `int | None` | Compression level for Hailo. |
| `disable_calibration` | `bool | None` | Early stop for Hailo. |
| `disable_compilation` | `bool | None` | Disable compilation for Hailo to output a .har file instead. |
| `disable_onnx_optimization` | `bool | None` | If true, disable the onnx optimization. |
| `disable_onnx_simplification` | `bool | None` | If true, disable the onnx simplification. |
| `inputs` | `list[InputParametersOnnxIr] | None` | The config defining the inputs of the model. |
| `max_quantization_images` | `MaxQuantizationImages | None` | The maximum number of images to use for quantization. |
| `model_config` |  |  |
| `name` | `str` | Name of the exported model. |
| `optimization_level` | `int | None` | Optimization level for Hailo. |

### class `Head`

```python
class Head(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `metadata` | `HeadObjectDetectionMetadata | HeadClassificationMetadata | HeadObjectDetectionSSDMetadata |
HeadSegmentationMetadata | HeadYOLOMetadata | HeadMetadata` | Metadata of the parser. |
| `name` | `str | None` | Optional name of the head. |
| `outputs` | `list[str] | None` | Specify which outputs are fed into the parser. If None, all outputs are fed. |
| `parser` | `str` | Name of the parser responsible for processing the models output. |

### class `HeadClassificationMetadata`

```python
class HeadClassificationMetadata(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `classes` | `list[str]` | Names of object classes recognized by the model. |
| `is_softmax` | `bool` | True, if output is already softmaxed. |
| `model_config` |  |  |
| `n_classes` | `int` | Number of object classes recognized by the model. |
| `postprocessor_path` | `str | None` | Path to the postprocessor. |

### class `HeadMetadata`

```python
class HeadMetadata(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `model_config` |  |  |
| `postprocessor_path` | `str | None` | Path to the postprocessor. |

### class `HeadObjectDetectionMetadata`

```python
class HeadObjectDetectionMetadata(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `anchors` | `list[list[list[float]]] | None` | Predefined bounding boxes of different sizes and aspect ratios. The innermost
lists are length 2 tuples of box sizes. The middle lists are anchors for each output. The outmost lists go from smallest to
largest output. |
| `classes` | `list[str]` | Names of object classes recognized by the model. |
| `conf_threshold` | `float` | Confidence score threshold above which a detected object is considered valid. |
| `iou_threshold` | `float` | Non-max supression threshold limiting boxes intersection. |
| `max_det` | `int` | Maximum detections per image. |
| `model_config` |  |  |
| `n_classes` | `int` | Number of object classes recognized by the model. |
| `postprocessor_path` | `str | None` | Path to the postprocessor. |

### class `HeadObjectDetectionSSDMetadata`

```python
class HeadObjectDetectionSSDMetadata(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `anchors` | `list[list[list[float]]] | None` | Predefined bounding boxes of different sizes and aspect ratios. The innermost
lists are length 2 tuples of box sizes. The middle lists are anchors for each output. The outmost lists go from smallest to
largest output. |
| `boxes_outputs` | `str` | Output name corresponding to predicted bounding box coordinates. |
| `classes` | `list[str]` | Names of object classes recognized by the model. |
| `conf_threshold` | `float` | Confidence score threshold above which a detected object is considered valid. |
| `iou_threshold` | `float` | Non-max supression threshold limiting boxes intersection. |
| `max_det` | `int` | Maximum detections per image. |
| `model_config` |  |  |
| `n_classes` | `int` | Number of object classes recognized by the model. |
| `postprocessor_path` | `str | None` | Path to the postprocessor. |
| `scores_outputs` | `str` | Output name corresponding to predicted bounding box confidence scores. |

### class `HeadSegmentationMetadata`

```python
class HeadSegmentationMetadata(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `classes` | `list[str]` | Names of object classes recognized by the model. |
| `is_softmax` | `bool` | True, if output is already softmaxed. |
| `model_config` |  |  |
| `n_classes` | `int` | Number of object classes recognized by the model. |
| `postprocessor_path` | `str | None` | Path to the postprocessor. |

### class `HeadYOLOMetadata`

```python
class HeadYOLOMetadata(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `anchors` | `list[list[list[float]]] | None` | Predefined bounding boxes of different sizes and aspect ratios. The innermost
lists are length 2 tuples of box sizes. The middle lists are anchors for each output. The outmost lists go from smallest to
largest output. |
| `angles_outputs` | `list[str] | None` | A list of output names for the angles. |
| `classes` | `list[str]` | Names of object classes recognized by the model. |
| `conf_threshold` | `float` | Confidence score threshold above which a detected object is considered valid. |
| `iou_threshold` | `float` | Non-max supression threshold limiting boxes intersection. |
| `is_softmax` | `bool | None` | True, if output is already softmaxed in YOLO instance segmentation. |
| `keypoints_outputs` | `list[str] | None` | A list of output names for the keypoints. |
| `mask_outputs` | `list[str] | None` | A list of output names for each mask output. |
| `max_det` | `int` | Maximum detections per image. |
| `model_config` |  |  |
| `n_classes` | `int` | Number of object classes recognized by the model. |
| `n_keypoints` | `int | None` | Number of keypoints per bbox in YOLO keypoint detection. |
| `n_prototypes` | `int | None` | Number of prototypes per bbox in YOLO instance segmnetation. |
| `postprocessor_path` | `str | None` | Path to the postprocessor. |
| `protos_outputs` | `str | None` | Output name for the protos. |
| `subtype` | `str` | YOLO family decoding subtype (e.g. yolov5, yolov6, yolov7 etc.). |
| `yolo_outputs` | `list[str]` | A list of output names for each of the different YOLO grid sizes. |

### class `HTTPValidationError`

```python
class HTTPValidationError(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `detail` | `list[ValidationError] | None` |  |

### class `Input`

```python
class Input(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `dtype` | `DataType` | Data type of the input data (e.g., 'float32'). |
| `input_type` | `InputType` | Type of input data (e.g., 'image'). |
| `layout` | `str | None` | Lettercode interpretation of the input data dimensions (e.g., 'NCHW') |
| `model_config` |  |  |
| `name` | `str` | Name of the input layer. |
| `preprocessing` | `PreprocessingBlock` | Preprocessing steps applied to the input data. |
| `shape` | `list[int]` | Shape of the input data as a list of integers (e.g. [H,W], [H,W,C], [N,H,W,C], ...). |

### class `InputParametersOnnxIr`

```python
class InputParametersOnnxIr(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `input_name` | `InputName | None` | The name of the input on the file level (e.g. name of input in the ONNX). Required for
multi-input but inferrable otherwise. |
| `layout` | `str | None` | The layout of the input which the NN accepts. |
| `mean_values` | `list[float] | None` | A list of mean values to be used for each channel. |
| `reverse_input_channels` | `bool | None` | DEPRECATED. If true, switched the input channels order from RGB to BGR. |
| `scale_values` | `list[float] | None` | A list of scale values to be used for each channel. |
| `shape` | `Shape | None` | The shape of the input which the NN accepts. |

### class `InputType`

```python
class InputType(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `image` | `str` |  |
| `raw` | `str` |  |

### class `JobMessageResponse`

```python
class JobMessageResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `arguments` | `dict[str, Any]` |  |
| `correlation_id` | `UUID | None` |  |
| `exception` | `str | None` | Exception message if any |
| `extra` | `dict[str, Any]` |  |
| `finished_at` | `NaiveDatetime | None` |  |
| `id` | `str` |  |
| `is_publishable` | `bool | None` | Whether message should be published to Hub or not. |
| `logs` | `str | None` |  |
| `name` | `str` |  |
| `queued_at` | `NaiveDatetime | None` |  |
| `result` | `Any` | Result returned by the job if completed successfully. |
| `started_at` | `NaiveDatetime | None` |  |
| `status` | `EnumJobStatusType` |  |
| `steps` | `list[JobStepResponse] | None` | For pipeline jobs: ordered list of all pipeline steps with their status. Null for
non-pipeline jobs. |
| `team_id` | `UUID | None` |  |
| `user_id` | `UUID | None` |  |

### class `JobStepResponse`

```python
class JobStepResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `name` | `str` |  |
| `status` | `EnumJobStatusType` |  |

### class `Metadata`

```python
class Metadata(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `name` | `str` | Name of the model. |
| `path` | `str` | Relative path to the model executable. |

### class `Model`

```python
class Model(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `heads` | `list[Head] | None` | List of Head objects defining the model heads. If not defined, we assume a raw output. |
| `inputs` | `list[Input]` | List of Input objects defining the model inputs. |
| `metadata` | `Metadata` | Metadata object defining the model metadata. |
| `model_config` |  |  |
| `outputs` | `list[Output]` | List of Output objects defining the model outputs. |

### class `ModelCreateRequest`

```python
class ModelCreateRequest(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `architecture_id` | `UUID | None` | Architecture ID specifying a trainable architecture. |
| `description` | `Description1 | None` | Description of the model. |
| `description_short` | `DescriptionShort | None` | Short description of the Model. |
| `is_public` | `bool` | Flag indicating if the Model is public. |
| `is_yolo` | `bool | None` | Whether the model is a YOLO model. |
| `license_type` | `EnumLicenseType` | Type of license. |
| `links` | `list[ModelLinkBase] | None` | Links to official Model pages. |
| `name` | `str` | Name of the Model. |
| `tasks` | `list[EnumTaskType] | None` | Array of types of tasks. |

### class `ModelDownloadResponse`

```python
class ModelDownloadResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `download_links` | `list[str]` | List of download links for the model instance. |
| `hash` | `str` | The MD5 hash of the model instance. |
| `model_id` | `str` | The ID of the model. |
| `model_instance_id` | `str` | The ID of the model instance. |
| `model_version_id` | `str` | The ID of the model version. |

### class `ModelInstanceDetailsRequest`

```python
class ModelInstanceDetailsRequest(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `model_instance_ids` | `list[UUID]` | List of IDs of the associated Model Instances. |

### class `ModelInstanceDetailsResponse`

```python
class ModelInstanceDetailsResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `model` | `ModelResponse` | Model details. |
| `model_instance` | `ModelInstanceResponse` | Model Instance details. |
| `model_version` | `ModelVersionResponse` | Model Version details. |

### class `ModelInstanceFileResponse`

```python
class ModelInstanceFileResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `created` | `NaiveDatetime` | Creation timestamp. |
| `file_size_bytes` | `int` | The size of the file in bytes. |
| `filepath` | `str` | Relative path to the file. |
| `id` | `str` | Unique identifier. |
| `model_instance_id` | `str` | ID of the associated ModelInstance. |
| `team_id` | `UUID` | Hub team ID. |
| `updated` | `NaiveDatetime` | Last update timestamp. |
| `user_id` | `UUID` | Hub user ID. |

### class `ModelInstancePatchRequest`

```python
class ModelInstancePatchRequest(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `description` | `Description2 | None` | Changelog of the ModelInstance. |
| `hardware_parameters` | `dict[str, Any] | None` | Hardware parameters of the Model. |
| `input_shape` | `list[list[InputShapeItem]] | None` | The input shape of the ModelInstance. |
| `is_deployable` | `bool | None` | Configure whether a ModelInstance is deployable or not. |
| `job_id` | `UUID | None` | ID of the Job associated with an exported Model. |
| `model_type` | `EnumModelType | None` | Type of the ModelInstance. |
| `model_version_id` | `UUID | None` | ID of the associated Model. |
| `name` | `Name1 | None` | Name of the ModelInstance. |
| `parent_id` | `UUID | None` | Unique identifier of the parent ModelInstance. |
| `quantization_data` | `EnumQuantizationDataType | UUID | str | None` | The data used to quantize this ModelInstance. It could be
a Dataset or a pre-defined domain. |
| `quantization_mode` | `EnumQuantizationMode | None` | Type of the precision of the ModelInstance. |
| `tags` | `list[str] | None` | List of tags associated with the Model. |
| `yolo_version` | `EnumYoloVersion | None` | If the model instance is PYTORCH and YOLO, the YOLO version of this instance. |

### class `ModelInstancePayloadParameters`

```python
class ModelInstancePayloadParameters(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `model_version_id` | `UUID` | ID of the associated Model Version. |

### class `ModelInstanceRequest`

```python
class ModelInstanceRequest(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `description` | `Description2 | None` | Changelog of the ModelInstance. |
| `hardware_parameters` | `dict[str, Any] | None` | Hardware parameters of the Model. |
| `input_shape` | `list[list[InputShapeItem]] | None` | The input shape of the ModelInstance. |
| `is_deployable` | `bool | None` | Configure whether a ModelInstance is deployable or not. |
| `job_id` | `UUID | None` | ID of the Job associated with an exported Model. |
| `model_type` | `EnumModelType` | Type of the ModelInstance. |
| `model_version_id` | `UUID` | ID of the associated Model Version. |
| `name` | `str` | Name of the ModelInstance. |
| `parent_id` | `UUID | None` | Unique identifier of the parent ModelInstance. |
| `quantization_data` | `EnumQuantizationDataType | UUID | str | None` | The data used to quantize this ModelInstance. It could be
a Dataset or a pre-defined domain. |
| `quantization_mode` | `EnumQuantizationMode | None` | Type of the precision of the ModelInstance. |
| `tags` | `list[str] | None` | List of tags associated with the Model. |
| `yolo_version` | `EnumYoloVersion | None` | If the model instance is PYTORCH and YOLO, the YOLO version of this instance. |

### class `ModelInstanceResponse`

```python
class ModelInstanceResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `created` | `NaiveDatetime` | Creation timestamp. |
| `description` | `Description2 | None` | Changelog of the ModelInstance. |
| `exportable_to` | `list[EnumModelType] | None` | The platforms that a ModelInstance can be exported to. |
| `hardware_parameters` | `dict[str, Any] | None` | Hardware parameters of the Model. |
| `hash` | `Hash | None` | The MD5 hash of the ModelInstance. |
| `hash_short` | `HashShort | None` | The first 7 characters of the MD5 hash. |
| `id` | `str` | Unique identifier. |
| `input_shape` | `list[list[InputShapeItem]] | None` | The input shape of the ModelInstance. |
| `is_nn_archive` | `bool` | If NN archive is used to store files. |
| `is_public` | `bool | None` | Whether a ModelInstance belongs to a public model. |
| `job_id` | `str | None` | ID of the Job associated with an exported Model. |
| `model_class` | `EnumModelClass | None` | DEPRECATED: Specifies whether the ModelVersion is a root, base, or exported model. |
| `model_id` | `str | None` | ID of the associated Model. |
| `model_precision_type` | `EnumModelPrecisionType | None` | Type of the precision of the ModelInstance. |
| `model_type` | `EnumModelType` | Type of the ModelInstance. |
| `model_version_id` | `str` | ID of the associated Model Version. |
| `model_version_name` | `str | None` | Name of the associated Model Version. |
| `name` | `str` | Name of the ModelInstance. |
| `parent_id` | `str | None` | Unique identifier of the parent ModelInstance. |
| `platforms` | `list[EnumModelType] | None` | List of supported platforms. |
| `quantization_data` | `EnumQuantizationDataType | str | None` | The data used to quantize this ModelInstance. It could be a
Dataset or a pre-defined domain. |
| `slug` | `str` | Slug for the ModelInstance. |
| `tags` | `list[str] | None` | List of tags associated with the Model. |
| `team_id` | `UUID` | Hub team ID. |
| `training_run_name` | `TrainingRunName | None` | Name of the training run that created this ModelInstance. |
| `updated` | `NaiveDatetime` | Last update timestamp. |
| `user_id` | `UUID` | Hub user ID. |
| `yolo_version` | `EnumYoloVersion | None` | If the model instance is PYTORCH and YOLO, the YOLO version of this instance. |

### class `ModelInstanceUploadResponse`

```python
class ModelInstanceUploadResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `job` | `JobMessageResponse` |  |
| `policy` | `GCSUploadPolicyResponse` |  |

### class `ModelLinkBase`

```python
class ModelLinkBase(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `link` | `str` | URL value of the link. |
| `name` | `str` | Name of the link, e.g. github or huggingface. |

### class `ModelLinkResponse`

```python
class ModelLinkResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `link` | `str` | URL value of the link. |
| `name` | `str` | Name of the link, e.g. github or huggingface. |

### class `ModelPatchRequest`

```python
class ModelPatchRequest(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `architecture_id` | `UUID | None` | Architecture ID specifying a trainable architecture. |
| `description` | `Description5 | None` | Description of the model. |
| `description_short` | `DescriptionShort | None` | Short description of the Model. |
| `is_public` | `bool | None` | Flag indicating if the Model is public. |
| `is_yolo` | `bool | None` | Whether the model is a YOLO model. |
| `license_type` | `EnumLicenseType | None` | Type of license. |
| `links` | `list[ModelLinkBase] | None` | Links to official Model pages. |
| `name` | `Name2 | None` | Name of the Model. |
| `project_id` | `UUID | None` | ID of the associated Project. |
| `tasks` | `list[EnumTaskType] | None` | Array of types of tasks. |

### class `ModelResponse`

```python
class ModelResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `architecture_id` | `str | None` | Architecture ID specifying a trainable architecture. |
| `created` | `NaiveDatetime` | Creation timestamp. |
| `description` | `Description5 | None` | Description of the model. |
| `description_short` | `DescriptionShort | None` | Short description of the Model. |
| `downloads` | `int` | Number of downloads. |
| `exportable_to` | `list[EnumModelType] | None` | The platforms that a ModelVersion can be exported to. |
| `exportable_types` | `list[EnumModelType] | None` | The types of models that can be exported to a target platform. Previously
called base model types. |
| `id` | `str` | Unique identifier. |
| `is_commercial` | `bool | None` | Is the model's license commercial. |
| `is_liked_by_user` | `bool | None` | True if the model is liked by the user. |
| `is_official` | `bool | None` | Is the model created by Luxonis. |
| `is_public` | `bool` | Flag indicating if the Model is public. |
| `is_yolo` | `bool | None` | Whether the model is a YOLO model. |
| `last_version_added` | `Any` | Timestamp of the latest base model. |
| `license_type` | `EnumLicenseType` | Type of license. |
| `likes` | `int | None` | Number of likes. |
| `links` | `list[ModelLinkResponse] | None` | Links to official Model pages. |
| `model_image_link` | `str | None` | The CDN link to upload/download model images. |
| `name` | `str` | Name of the Model. |
| `platforms` | `list[EnumModelType] | None` | List of supported platforms. |
| `project_id` | `str | None` | Project ID associated with this model. |
| `slug` | `str` | Slug for the Model. |
| `tasks` | `list[EnumTaskType] | None` | Array of types of tasks. |
| `team_id` | `UUID | None` | Hub team ID. Will be hidden/null for unauthenticated users. |
| `team_name` | `str | None` | Hub team name. |
| `team_slug` | `str | None` | Hub team slug. |
| `updated` | `NaiveDatetime` | Last update timestamp. |
| `user_id` | `UUID` | Hub user ID. |
| `versions` | `int | None` | Number of versions. |

### class `ModelVersionDownloadResponse`

```python
class ModelVersionDownloadResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `download_link` | `str` | Presigned URL to download a file belonging to this instance. |
| `model_instance_name` | `str` | Name of the ModelInstance for the download link. |

### class `ModelVersionPatchRequest`

```python
class ModelVersionPatchRequest(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `commit_hash` | `CommitHash | None` | Commit hash of the model in repository. |
| `description` | `Description7 | None` | Changelog of the ModelVersion. |
| `domain` | `EnumDomain | None` | Domain type. |
| `model_id` | `UUID | None` | ID of the associated Model. |
| `name` | `Name3 | None` | Name of the ModelVersion. |
| `repository_url` | `RepositoryUrl | None` | URL of the model's repository. |
| `tags` | `list[str] | None` | List of tags associated with the ModelVersion. |
| `training_run_id` | `UUID | None` | ID of the training run that created this ModelVersion. |
| `training_run_name` | `TrainingRunName1 | None` | Name of the training run that created this ModelVersion. |
| `version` | `Version | None` | Semantic version of this ModelVersion (for use with model variants). It should be in the format
X.Y or X.Y.Z |

### class `ModelVersionPayloadParameters`

```python
class ModelVersionPayloadParameters(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `height` | `int` | Height of the ModelVersion. |
| `model_id` | `UUID` | ID of the associated Model. |
| `width` | `int` | Width of the ModelVersion. |

### class `ModelVersionRequest`

```python
class ModelVersionRequest(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `commit_hash` | `CommitHash | None` | Commit hash of the model in repository. |
| `description` | `Description7 | None` | Changelog of the ModelVersion. |
| `domain` | `EnumDomain | None` | Domain type. |
| `model_id` | `UUID` | ID of the associated Model. |
| `name` | `str` | Name of the ModelVersion. |
| `repository_url` | `RepositoryUrl | None` | URL of the model's repository. |
| `tags` | `list[str] | None` | List of tags associated with the ModelVersion. |
| `training_run_id` | `UUID | None` | ID of the training run that created this ModelVersion. |
| `training_run_name` | `TrainingRunName1 | None` | Name of the training run that created this ModelVersion. |
| `version` | `str` | Semantic version of this ModelVersion (for use with model variants). It should be in the format X.Y or X.Y.Z
|

### class `ModelVersionResponse`

```python
class ModelVersionResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `available_for` | `list[AvailableForModel] | None` | A list of available target platforms along with the best matching model
instance ID for download. |
| `commit_hash` | `CommitHash | None` | Commit hash of the model in repository. |
| `created` | `NaiveDatetime` | Creation timestamp. |
| `description` | `Description7 | None` | Changelog of the ModelVersion. |
| `domain` | `EnumDomain | None` | Domain type. |
| `exportable_to` | `list[EnumModelType] | None` | The platforms that a ModelVersion can be exported to. |
| `exportable_types` | `list[EnumModelType] | None` | The types of models that can be exported to a target platform. Previously
called base model types. |
| `has_base_nn_archive` | `bool | None` | Whether the ModelVersion has a base model with a NN archive. |
| `id` | `str` | Unique identifier. |
| `is_public` | `bool | None` | Whether a ModelVersion belongs to a public model. |
| `model_id` | `str` | ID of the associated Model. |
| `name` | `str` | Name of the ModelVersion. |
| `number_base_files` | `int | None` | Number of base files under the ModelVersion. |
| `platforms` | `list[EnumModelType] | None` | List of supported platforms. |
| `repository_url` | `RepositoryUrl | None` | URL of the model's repository. |
| `slug` | `str` | Slug for the ModelVersion. |
| `tags` | `list[str] | None` | List of tags associated with the ModelVersion. |
| `team_id` | `UUID` | Hub team ID. |
| `training_run_id` | `str | None` | ID of the training run that created this ModelVersion. |
| `training_run_name` | `TrainingRunName1 | None` | Name of the training run that created this ModelVersion. |
| `updated` | `NaiveDatetime` | Last update timestamp. |
| `user_id` | `UUID` | Hub user ID. |
| `variant_slug` | `str` | Slug of the variant of this ModelVersion. |
| `version` | `str` | Semantic version of this ModelVersion (for use with model variants). It should be in the format X.Y or X.Y.Z
|

### class `NumberOfShaves`

```python
class NumberOfShaves(IntEnum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `integer_1` | `int` |  |
| `integer_10` | `int` |  |
| `integer_11` | `int` |  |
| `integer_12` | `int` |  |
| `integer_13` | `int` |  |
| `integer_14` | `int` |  |
| `integer_15` | `int` |  |
| `integer_16` | `int` |  |
| `integer_2` | `int` |  |
| `integer_3` | `int` |  |
| `integer_4` | `int` |  |
| `integer_5` | `int` |  |
| `integer_6` | `int` |  |
| `integer_7` | `int` |  |
| `integer_8` | `int` |  |
| `integer_9` | `int` |  |

### class `Output`

```python
class Output(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `dtype` | `DataType` | Data type of the output data (e.g., 'float32'). |
| `layout` | `str | None` | List of letters describing the output layout (e.g. 'NC'). |
| `model_config` |  |  |
| `name` | `str` | Name of the output layer. |
| `shape` | `list[int] | None` | Shape of the output as a list of integers (e.g. [1, 1000]). |

### class `PerformanceRating`

```python
class PerformanceRating(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `accuracy_rating` | `int | None` | Accuracy rating of the architecture on a scale of 1-10. |
| `fps_rating` | `FpsRating | None` | FPS rating of the architecture. |
| `speed_rating` | `int | None` | Speed rating of the architecture on a scale of 1-10. |

### class `PerformanceRatings`

```python
class PerformanceRatings(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `hailo_ratings` | `PerformanceRating` | Speed and accuracy rating for Hailo. |
| `rvc2_ratings` | `PerformanceRating` | Speed and accuracy rating for RVC2. |
| `rvc3_ratings` | `PerformanceRating` | Speed and accuracy rating for RVC3. |
| `rvc4_ratings` | `PerformanceRating` | Speed and accuracy rating for RVC4. |

### class `PreprocessingBlock`

```python
class PreprocessingBlock(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `dai_type` | `str | None` | DepthAI input type which is read by DepthAI to automatically setup the pipeline. |
| `interleaved_to_planar` | `bool | None` | If True input to the model is interleaved (NHWC) else planar (NCHW). |
| `mean` | `list[float] | None` | Mean values in channel order. Order depends on the order in which the model was trained on. |
| `model_config` |  |  |
| `reverse_channels` | `bool | None` | If True input to the model is RGB else BGR. |
| `scale` | `list[float] | None` | Standardization values in channel order. Order depends on the order in which the model was
trained on. |

### class `RVC2ExportParametersOnnxIrPresetResponse`

```python
class RVC2ExportParametersOnnxIrPresetResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `compile_tool_args` | `list[str] | None` | Additional args to pass to compile_tool for RVC2. |
| `disable_onnx_optimization` | `bool | None` | If true, disable the onnx optimization. |
| `disable_onnx_simplification` | `bool | None` | If true, disable the onnx simplification. |
| `inputs` | `list[InputParametersOnnxIr] | None` | The config defining the inputs of the model. |
| `max_quantization_images` | `MaxQuantizationImages | None` | The maximum number of images to use for quantization. |
| `mo_args` | `list[str] | None` | Additional OpenVINO model optimizer args to be used for RVC2. |
| `model_config` |  |  |
| `name` | `str` | Name of the exported model. |
| `number_of_shaves` | `NumberOfShaves | None` | Number of shaves to use for legacy RVC2. |
| `quantization_data` | `EnumQuantizationDataType | str | None` | Either the domain name of the predefined quantization data (e.g.
WAREHOUSE) or a UUID specifying a custom dataset. |

### class `RVC3ExportParametersOnnxIr`

```python
class RVC3ExportParametersOnnxIr(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `compile_tool_args` | `list[str] | None` | Additional args to pass to compile_tool for RVC3. |
| `disable_onnx_optimization` | `bool | None` | If true, disable the onnx optimization. |
| `disable_onnx_simplification` | `bool | None` | If true, disable the onnx simplification. |
| `inputs` | `list[InputParametersOnnxIr] | None` | The config defining the inputs of the model. |
| `ir_version` | `Literal['2022.3.0']` | Modelconverter image version to be used for export. |
| `max_quantization_images` | `MaxQuantizationImages | None` | The maximum number of images to use for quantization. |
| `mo_args` | `list[str] | None` | Additional OpenVINO model optimizer args to be used for RVC3. |
| `model_config` |  |  |
| `name` | `str` | Name of the exported model. |
| `quantization_data` | `EnumQuantizationDataType | str | None` | Either the domain name of the predefined quantization data (e.g.
WAREHOUSE) or a UUID specifying a custom dataset. |

### class `RVC4ExportParametersOnnxIr`

```python
class RVC4ExportParametersOnnxIr(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `disable_onnx_optimization` | `bool | None` | If true, disable the onnx optimization. |
| `disable_onnx_simplification` | `bool | None` | If true, disable the onnx simplification. |
| `inputs` | `list[InputParametersOnnxIr] | None` | The config defining the inputs of the model. |
| `max_quantization_images` | `MaxQuantizationImages | None` | The maximum number of images to use for quantization. |
| `model_config` |  |  |
| `name` | `str` | Name of the exported model. |
| `quantization_data` | `EnumQuantizationDataType | str | None` | Either the domain name of the predefined quantization data (e.g.
WAREHOUSE) or a UUID specifying a custom dataset. |
| `snpe_dlc_graph_prepare_args` | `list[str] | None` | Additional args to pass to snpe-dlc-graph-prepare for RVC4. |
| `snpe_dlc_quant_args` | `list[str] | None` | Additional args to pass to snpe-dlc-quant for RVC4. |
| `snpe_onnx_to_dlc_args` | `list[str] | None` | Additional args to pass to SNPE onnx-to-dlc for RVC4. |
| `target_precision` | `EnumQuantizationMode | None` | Target precision for RVC4. |

### class `SnpeVersion`

```python
class SnpeVersion(Enum)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `field_2_32_6` | `str` |  |
| `field_2_41_0` | `str` |  |

### class `TraceToggleRequest`

```python
class TraceToggleRequest(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `enabled` | `bool` | Whether tracing is enabled for this service. |

### class `UploadQuantizationZipResponse`

```python
class UploadQuantizationZipResponse(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `upload_url` | `str` | Short-lived signed URL used to upload the custom quantization zip. |

### class `ValidationError`

```python
class ValidationError(BaseModel)
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `loc` | `list[str | int]` |  |
| `msg` | `str` |  |
| `type` | `str` |  |

## Module Attributes

| Name | Description |
| --- | --- |
| [`CommitHash`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
| [`Description`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) | |
| [`Description1`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |
|
| [`Description2`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |
|
| [`Description5`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |
|
| [`Description7`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |
|
|
[`DescriptionShort`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`FpsRating`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
| [`Hash`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
| [`HashShort`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
| [`InputName`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
| [`InputShapeItem`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`MaxQuantizationImages`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`Name`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
| [`Name1`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
| [`Name2`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
| [`Name3`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
| [`RepositoryUrl`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |
|
| [`Shape`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
| [`ShapeItem`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |
| [`TrainingRunName`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
|
[`TrainingRunName1`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md)
| |
| [`Version`](https://docs.luxonis.com/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/hubai_models.md) |  |

### variable `CommitHash`

```python
CommitHash = TypeAliasType(
    'CommitHash',
    Annotated[str, Field(description='Commit hash of the model in repository.', max_length=255, title='Commit Hash')],
)
```

### variable `Description`

```python
Description = TypeAliasType(
    'Description',
    Annotated[str, Field(description='Description of the architecture.', max_length=255, title='Description')],
)
```

### variable `Description1`

```python
Description1 = TypeAliasType(
    'Description1',
    Annotated[str, Field(description='Description of the model.', max_length=10000, title='Description')],
)
```

### variable `Description2`

```python
Description2 = TypeAliasType(
    'Description2',
    Annotated[str, Field(description='Changelog of the ModelInstance.', max_length=255, title='Description')],
)
```

### variable `Description5`

```python
Description5 = TypeAliasType(
    'Description5',
    Annotated[str, Field(description='Description of the model.', max_length=10000, title='Description')],
)
```

### variable `Description7`

```python
Description7 = TypeAliasType(
    'Description7',
    Annotated[str, Field(description='Changelog of the ModelVersion.', max_length=255, title='Description')],
)
```

### variable `DescriptionShort`

```python
DescriptionShort = TypeAliasType(
    'DescriptionShort',
    Annotated[str, Field(description='Short description of the Model.', max_length=255, title='Description Short')],
)
```

### variable `FpsRating`

```python
FpsRating = TypeAliasType(
    'FpsRating',
    Annotated[float, Field(description='FPS rating of the architecture.', ge=0.0, title='Fps Rating')],
)
```

### variable `Hash`

```python
Hash = TypeAliasType(
    'Hash',
    Annotated[str, Field(description='The MD5 hash of the ModelInstance.', max_length=255, title='Hash')],
)
```

### variable `HashShort`

```python
HashShort = TypeAliasType(
    'HashShort',
    Annotated[str, Field(description='The first 7 characters of the MD5 hash.', max_length=7, title='Hash Short')],
)
```

### variable `InputName`

```python
InputName = TypeAliasType(
    'InputName',
    Annotated[str, Field(description='The name of the input on the file level (e.g. name of input in the ONNX). Required for multi-input but inferrable otherwise.', max_length=255, title='Input Name')],
)
```

### variable `InputShapeItem`

```python
InputShapeItem = TypeAliasType('InputShapeItem', Annotated[int, Field(gt=0)])
```

### variable `MaxQuantizationImages`

```python
MaxQuantizationImages = TypeAliasType(
    'MaxQuantizationImages',
    Annotated[int, Field(description='The maximum number of images to use for quantization.', ge=1, title='Max Quantization Images')],
)
```

### variable `Name`

```python
Name = TypeAliasType(
    'Name',
    Annotated[str, Field(description='Name of the Architecture.', max_length=255, title='Name')],
)
```

### variable `Name1`

```python
Name1 = TypeAliasType(
    'Name1',
    Annotated[str, Field(description='Name of the ModelInstance.', max_length=255, title='Name')],
)
```

### variable `Name2`

```python
Name2 = TypeAliasType(
    'Name2',
    Annotated[str, Field(description='Name of the Model.', max_length=255, title='Name')],
)
```

### variable `Name3`

```python
Name3 = TypeAliasType(
    'Name3',
    Annotated[str, Field(description='Name of the ModelVersion.', max_length=255, title='Name')],
)
```

### variable `RepositoryUrl`

```python
RepositoryUrl = TypeAliasType(
    'RepositoryUrl',
    Annotated[str, Field(description="URL of the model's repository.", max_length=255, title='Repository Url')],
)
```

### variable `Shape`

```python
Shape = TypeAliasType(
    'Shape',
    Annotated[list[ShapeItem], Field(description='The shape of the input which the NN accepts.', max_length=6, min_length=2, title='Shape')],
)
```

### variable `ShapeItem`

```python
ShapeItem = TypeAliasType('ShapeItem', Annotated[int, Field(gt=0)])
```

### variable `TrainingRunName`

```python
TrainingRunName = TypeAliasType(
    'TrainingRunName',
    Annotated[str, Field(description='Name of the training run that created this ModelInstance.', max_length=255, title='Training Run Name')],
)
```

### variable `TrainingRunName1`

```python
TrainingRunName1 = TypeAliasType(
    'TrainingRunName1',
    Annotated[str, Field(description='Name of the training run that created this ModelVersion.', max_length=255, title='Training Run Name')],
)
```

### variable `Version`

```python
Version = TypeAliasType(
    'Version',
    Annotated[str, Field(description='Semantic version of this ModelVersion (for use with model variants). It should be in the format X.Y or X.Y.Z', max_length=255, title='Version')],
)
```
