# HubAI SDK API 参考

Python API: `hubai_sdk`

源版本: `v0.3.4` (提交 `b856d87c19ace025ba0c3c20f47920825e45ee48`)

用于管理和转换 HubAI 模型的客户端库。

HubAI 以三级层次结构存储模型资源：

 1. 模型描述了架构、任务、许可证和可见性。
 2. 变体是该模型的命名和版本化实现。
 3. 实例是具体的模型工件，例如 ONNX 模型或用于 RVC2、RVC3、RVC4 或 Hailo 的导出工件。

[HubAIClient](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/hubai_client.md) 是主要入口点。它验证
API 密钥并公开
[hubai_sdk.services.models](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/services/models.md)、[hubai_sdk.services.variants](https://docs.luxonis.com/zh/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/services/variants.md)、[hubai_sdk.services.instances](https://docs.luxonis.com/zh/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/services/instances.md)
和
[hubai_sdk.services.convert](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/services/convert.md)
模块作为属性。

> **示例**
> 列出公共对象检测模型并检查第一个结果。

```python
from hubai_sdk import HubAIClient

client = HubAIClient()
models = client.models.list_models(
    tasks=["OBJECT_DETECTION"],
    is_public=True,
)

if models:
    model = client.models.get_model(models[0].id)
    print(model.name, model.tasks)
```

 * `身份验证:`: 将 API 密钥传递给
   [HubAIClient](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/hubai_client.md)，设置
   `HUBAI_API_KEY` 环境变量，或使用 `hubai login` 存储密钥。显式构造函数参数优先于环境和存储的凭据。

> **另请参阅**
> [hubai_sdk.services.convert](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/services/convert.md) 用于托管转换工作流，[hubai_sdk.utils.sdk_models](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/sdk_models.md) 用于服务函数返回的响应对象。

## 子页面

 * [服务](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/services.md)
 * [工具](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils.md)
 * [CLI](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/__main__.md)
 * [错误](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/errors.md)
 * [hubai_client](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/hubai_client.md)
 * [类型](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/typing.md)

## 属性

### version
