# hubai_models

Python API: `hubai_sdk.utils.hubai_models`

## Classes

### ArchitecturePatchRequest

#### Attributes

##### description

##### is_public

##### license_type

##### name

##### performance_ratings

##### tasks

##### training_hyperparameter_config

##### training_image

##### training_loader_config

##### training_model_config

### ArchitectureRequest

#### Attributes

##### description

##### is_public

##### license_type

##### name

##### performance_ratings

##### tasks

##### training_hyperparameter_config

##### training_image

##### training_loader_config

##### training_model_config

### ArchitectureResponse

#### Attributes

##### created

##### description

##### id

##### is_public

##### license_type

##### name

##### performance_ratings

##### slug

##### tasks

##### team_id

##### training_hyperparameter_config

##### training_image

##### training_loader_config

##### training_model_config

##### updated

##### user_id

### ArchiveConfigurationRequest

#### Attributes

##### config_version

##### model

##### model_config

### ArchiveConfigurationResponse

#### Attributes

##### config_version

##### model

##### model_config

### AvailableForModel

#### Attributes

##### id

##### platform

### BodyDownloadApiV1ModelsDownloadGet

#### Attributes

##### snpe_version

##### tags

### BodyReadAllModelInstancesApiV1ModelInstancesGet

#### Attributes

##### input_shape

##### multiple_model_version_ids

##### platforms

##### snpe_version

##### tags

### BodyUploadModelInstanceFileApiV1ModelInstancesModelInstanceIdUploadPost

#### Attributes

##### files

### DataType

#### Attributes

##### boolean

##### float16

##### float32

##### float64

##### int16

##### int32

##### int4

##### int64

##### int8

##### string

##### uint16

##### uint32

##### uint4

##### uint64

##### uint8

### EnumChannelEncoding

#### Attributes

##### BGR

##### GRAY

##### NONE

##### RGB

### EnumDomain

#### Attributes

##### GENERAL

### EnumHailoVersion

#### Attributes

##### field_2024_07

##### field_2024_10

### EnumIRVersion

#### Attributes

##### field_2021_4_0

##### field_2022_3_0

### EnumJobStatusType

#### Attributes

##### CANCELLED

##### COMPLETED

##### FAILED

##### QUEUED

##### RUNNING

##### SHUTDOWN

### EnumLicenseType

#### Attributes

##### Apache_2_0

##### BSD_3_Clause

##### CreativeML_Open_RAIL_M

##### GNU_Affero_General_Public_License_v3_0

##### GNU_General_Public_License_v3_0

##### MIT

##### NTU_S_Lab_1_0

##### Ultralytics_Enterprise

##### undefined

### EnumModelClass

#### Attributes

##### BASE

##### EXPORTED

### EnumModelInstanceStatus

#### Attributes

##### available

##### unavailable

### EnumModelPrecisionType

#### Attributes

##### FP16

##### FP32

##### INT8

##### INT8_INT16

### EnumModelType

#### Attributes

##### HAILO

##### IR

##### ONNX

##### PYTORCH

##### RVC2

##### RVC2_LEGACY

##### RVC3

##### RVC4

##### TFLITE

### EnumPotTargetDevice

#### Attributes

##### ANY

##### VPU

### EnumQuantizationDataType

#### Attributes

##### CLIP

##### CUSTOM

##### DRIVING

##### FOOD

##### GENERAL

##### INDOORS

##### RANDOM

##### UNKNOWN

##### WAREHOUSE

### EnumQuantizationMode

#### Attributes

##### FP16_STANDARD

##### FP32_STANDARD

##### INT8_ACCURACY_FOCUSED

##### INT8_INT16_MIXED

##### INT8_INT16_MIXED_ACCURACY_FOCUSED

##### INT8_STANDARD

### EnumSampleSplitType

#### Attributes

##### TEST

##### TRAIN

##### VAL

### EnumSortOrder

#### Attributes

##### asc

##### desc

### EnumTaskType

#### Attributes

##### CLASSIFICATION

##### DENOISING

##### DEPTH_ESTIMATION

##### FEATURE_DETECTION

##### IMAGE_EMBEDDING

##### INSTANCE_SEGMENTATION

##### KEYPOINT_DETECTION

##### LINE_DETECTION

##### LOW_LIGHT_ENHANCEMENT

##### OBJECT_DETECTION

##### OPTICAL_CHARACTER_RECOGNITION

##### REGRESSION

##### SEGMENTATION

##### SPEECH_RECOGNITION

##### SUPER_RESOLUTION

### EnumYoloVersion

#### Attributes

##### goldyolo

##### yolov10

##### yolov11

##### yolov12

##### yolov26

##### yolov5

##### yolov6r1

##### yolov6r3

##### yolov6r4

##### yolov7

##### yolov8

##### yolov9

### GCSUploadPolicyFields

#### Attributes

##### key

##### policy

##### success_action_status

##### x_goog_algorithm

##### x_goog_credential

##### x_goog_date

##### x_goog_signature

### GCSUploadPolicyResponse

#### Attributes

##### fields

##### url

### GetFromSlugsRequest

#### Attributes

##### items

##### model_slugs

##### team_slugs

##### variant_slugs

### GetFromSlugsRequestItem

#### Attributes

##### identifier

##### slug

### GetFromSlugsResponse

#### Attributes

##### items

### GetFromSlugsResponseItem

#### Attributes

##### identifier

##### model

##### model_version

### HailoExportParametersOnnxIr

#### Attributes

##### alls

##### batch_size

##### compression_level

##### disable_calibration

##### disable_compilation

##### disable_onnx_optimization

##### disable_onnx_simplification

##### inputs

##### max_quantization_images

##### model_config

##### name

##### optimization_level

### Head

#### Attributes

##### metadata

##### name

##### outputs

##### parser

### HeadClassificationMetadata

#### Attributes

##### classes

##### is_softmax

##### model_config

##### n_classes

##### postprocessor_path

### HeadMetadata

#### Attributes

##### model_config

##### postprocessor_path

### HeadObjectDetectionMetadata

#### Attributes

##### anchors

##### classes

##### conf_threshold

##### iou_threshold

##### max_det

##### model_config

##### n_classes

##### postprocessor_path

### HeadObjectDetectionSSDMetadata

#### Attributes

##### anchors

##### boxes_outputs

##### classes

##### conf_threshold

##### iou_threshold

##### max_det

##### model_config

##### n_classes

##### postprocessor_path

##### scores_outputs

### HeadSegmentationMetadata

#### Attributes

##### classes

##### is_softmax

##### model_config

##### n_classes

##### postprocessor_path

### HeadYOLOMetadata

#### Attributes

##### anchors

##### angles_outputs

##### classes

##### conf_threshold

##### iou_threshold

##### is_softmax

##### keypoints_outputs

##### mask_outputs

##### max_det

##### model_config

##### n_classes

##### n_keypoints

##### n_prototypes

##### postprocessor_path

##### protos_outputs

##### subtype

##### yolo_outputs

### HTTPValidationError

#### Attributes

##### detail

### Input

#### Attributes

##### dtype

##### input_type

##### layout

##### model_config

##### name

##### preprocessing

##### shape

### InputParametersOnnxIr

#### Attributes

##### input_name

##### layout

##### mean_values

##### reverse_input_channels

##### scale_values

##### shape

### InputType

#### Attributes

##### image

##### raw

### JobMessageResponse

#### Attributes

##### arguments

##### correlation_id

##### exception

##### extra

##### finished_at

##### id

##### is_publishable

##### logs

##### name

##### queued_at

##### result

##### started_at

##### status

##### steps

##### team_id

##### user_id

### JobStepResponse

#### Attributes

##### name

##### status

### Metadata

#### Attributes

##### name

##### path

### Model

#### Attributes

##### heads

##### inputs

##### metadata

##### model_config

##### outputs

### ModelCreateRequest

#### Attributes

##### architecture_id

##### description

##### description_short

##### is_public

##### is_yolo

##### license_type

##### links

##### name

##### tasks

### ModelDownloadResponse

#### Attributes

##### download_links

##### hash

##### model_id

##### model_instance_id

##### model_version_id

### ModelInstanceDetailsRequest

#### Attributes

##### model_instance_ids

### ModelInstanceDetailsResponse

#### Attributes

##### model

##### model_instance

##### model_version

### ModelInstanceFileResponse

#### Attributes

##### created

##### file_size_bytes

##### filepath

##### id

##### model_instance_id

##### team_id

##### updated

##### user_id

### ModelInstancePatchRequest

#### Attributes

##### description

##### hardware_parameters

##### input_shape

##### is_deployable

##### job_id

##### model_type

##### model_version_id

##### name

##### parent_id

##### quantization_data

##### quantization_mode

##### tags

##### yolo_version

### ModelInstancePayloadParameters

#### Attributes

##### model_version_id

### ModelInstanceRequest

#### Attributes

##### description

##### hardware_parameters

##### input_shape

##### is_deployable

##### job_id

##### model_type

##### model_version_id

##### name

##### parent_id

##### quantization_data

##### quantization_mode

##### tags

##### yolo_version

### ModelInstanceResponse

#### Attributes

##### created

##### description

##### exportable_to

##### hardware_parameters

##### hash

##### hash_short

##### id

##### input_shape

##### is_nn_archive

##### is_public

##### job_id

##### model_class

##### model_id

##### model_precision_type

##### model_type

##### model_version_id

##### model_version_name

##### name

##### parent_id

##### platforms

##### quantization_data

##### slug

##### tags

##### team_id

##### training_run_name

##### updated

##### user_id

##### yolo_version

### ModelInstanceUploadResponse

#### Attributes

##### job

##### policy

### ModelLinkBase

#### Attributes

##### link

##### name

### ModelLinkResponse

#### Attributes

##### link

##### name

### ModelPatchRequest

#### Attributes

##### architecture_id

##### description

##### description_short

##### is_public

##### is_yolo

##### license_type

##### links

##### name

##### project_id

##### tasks

### ModelResponse

#### Attributes

##### architecture_id

##### created

##### description

##### description_short

##### downloads

##### exportable_to

##### exportable_types

##### id

##### is_commercial

##### is_liked_by_user

##### is_official

##### is_public

##### is_yolo

##### last_version_added

##### license_type

##### likes

##### links

##### model_image_link

##### name

##### platforms

##### project_id

##### slug

##### tasks

##### team_id

##### team_name

##### team_slug

##### updated

##### user_id

##### versions

### ModelVersionDownloadResponse

#### Attributes

##### download_link

##### model_instance_name

### ModelVersionPatchRequest

#### Attributes

##### commit_hash

##### description

##### domain

##### model_id

##### name

##### repository_url

##### tags

##### training_run_id

##### training_run_name

##### version

### ModelVersionPayloadParameters

#### Attributes

##### height

##### model_id

##### width

### ModelVersionRequest

#### Attributes

##### commit_hash

##### description

##### domain

##### model_id

##### name

##### repository_url

##### tags

##### training_run_id

##### training_run_name

##### version

### ModelVersionResponse

#### Attributes

##### available_for

##### commit_hash

##### created

##### description

##### domain

##### exportable_to

##### exportable_types

##### has_base_nn_archive

##### id

##### is_public

##### model_id

##### name

##### number_base_files

##### platforms

##### repository_url

##### slug

##### tags

##### team_id

##### training_run_id

##### training_run_name

##### updated

##### user_id

##### variant_slug

##### version

### NumberOfShaves

#### Attributes

##### integer_1

##### integer_10

##### integer_11

##### integer_12

##### integer_13

##### integer_14

##### integer_15

##### integer_16

##### integer_2

##### integer_3

##### integer_4

##### integer_5

##### integer_6

##### integer_7

##### integer_8

##### integer_9

### Output

#### Attributes

##### dtype

##### layout

##### model_config

##### name

##### shape

### PerformanceRating

#### Attributes

##### accuracy_rating

##### fps_rating

##### speed_rating

### PerformanceRatings

#### Attributes

##### hailo_ratings

##### rvc2_ratings

##### rvc3_ratings

##### rvc4_ratings

### PreprocessingBlock

#### Attributes

##### dai_type

##### interleaved_to_planar

##### mean

##### model_config

##### reverse_channels

##### scale

### RVC2ExportParametersOnnxIrPresetResponse

#### Attributes

##### compile_tool_args

##### disable_onnx_optimization

##### disable_onnx_simplification

##### inputs

##### max_quantization_images

##### mo_args

##### model_config

##### name

##### number_of_shaves

##### quantization_data

### RVC3ExportParametersOnnxIr

#### Attributes

##### compile_tool_args

##### disable_onnx_optimization

##### disable_onnx_simplification

##### inputs

##### ir_version

##### max_quantization_images

##### mo_args

##### model_config

##### name

##### quantization_data

### RVC4ExportParametersOnnxIr

#### Attributes

##### disable_onnx_optimization

##### disable_onnx_simplification

##### inputs

##### max_quantization_images

##### model_config

##### name

##### quantization_data

##### snpe_dlc_graph_prepare_args

##### snpe_dlc_quant_args

##### snpe_onnx_to_dlc_args

##### target_precision

### SnpeVersion

#### Attributes

##### field_2_32_6

##### field_2_41_0

### TraceToggleRequest

#### Attributes

##### enabled

### UploadQuantizationZipResponse

#### Attributes

##### upload_url

### ValidationError

#### Attributes

##### loc

##### msg

##### type

## Attributes

### CommitHash

### Description

### Description1

### Description2

### Description5

### Description7

### DescriptionShort

### FpsRating

### Hash

### HashShort

### InputName

### InputShapeItem

### MaxQuantizationImages

### Name

### Name1

### Name2

### Name3

### RepositoryUrl

### Shape

### ShapeItem

### TrainingRunName

### TrainingRunName1

### Version
