# variants

Python API: `hubai_sdk.services.variants`

管理 HubAI 模型的命名和版本化变体。

变体将相关的模型实例按语义版本分组。例如，一个模型可以有针对不同输入分辨率或训练数据集的独立变体，每个变体可以有诸如 `"1.0.0"` 和 `"1.1.0"` 等版本。

> **示例**
> ```python
variant = client.variants.create_variant(
    "coco-640x640",
    model_id=model.id,
    variant_version="1.0.0",
    tags=["coco"],
)
instances = client.instances.list_instances(variant_id=variant.id)
```

接受 `identifier` 的函数解析 UUID、原始模型版本 slug 和模型变体资源路径。资源路径可以包含版本以选择一个确切的模型版本。删除变体将远程删除资源，并且无法通过 SDK 撤消。

## 函数

### create_variant

```python
def create_variant(name: str, *, model_id: UUID | str, variant_version: str, description: str | None = None, repository_url: str |
None = None, commit_hash: str | None = None, domain: str | None = None, tags: list[str] | None = None) -> ModelVersionResponse:
```

在模型下创建版本化变体。

参数

 * `name` (`str`): 人类可读的变体名称。
 * `model_id` (`UUID | str`): 父模型的 UUID。
 * `variant_version` (`str`): 此变体的版本字符串。
 * `description` (`str | None`): 变体的完整描述。
 * `repository_url` (`str | None`): 源存储库 URL。
 * `commit_hash` (`str | None`): 用于生成变体的源修订。
 * `domain` (`str | None`): 应用程序或数据集域。
 * `tags` (`list[str] | None`): 变体的可搜索标签。

返回

 * `ModelVersionResponse`: 创建的模型版本资源。

引发

 * `ResourceConflictError`: 如果变体已存在于模型中。
 * `HubApiError`: 如果 HubAI 因其他原因拒绝请求。

### create_variant_cli

```python
def create_variant_cli(name: str, *, model_id: UUID | str, variant_version: str, description: str | None = None, repository_url:
str | None = None, commit_hash: str | None = None, domain: str | None = None, tags: list[str] | None = None):
```

创建模型的新变体。

### delete_variant

```python
def delete_variant(identifier: UUID | str):
```

从 HubAI 删除模型变体。

参数

 * `identifier` (`UUID | str`): 变体 UUID、原始模型版本 slug 或变体资源路径。当变体 slug 标识多个模型版本时，请包含其版本段。

### delete_variant_cli

```python
def delete_variant_cli(identifier: UUID | str):
```

删除模型变体。

### get_variant

```python
def get_variant(identifier: UUID | str) -> ModelVersionResponse:
```

按标识符获取一个模型变体。

参数

 * `identifier` (`UUID | str`): 变体 UUID、原始模型版本 slug 或 `<model>:<variant>[:<version>]` 资源路径，可选地以 `<team>/` 为前缀。

返回

 * `ModelVersionResponse`: 解析的模型版本资源。

### get_variant_info_cli

```python
def get_variant_info_cli(identifier: UUID | str):
```

返回有关模型版本的信息。

### list_variants

```python
def list_variants(model_id: UUID | str | None = None, name: str | None = None, variant_slug: str | None = None, variant_version:
str | None = None, is_public: bool | None = None, include_model_name: bool = False, limit: int = 50, sort: str = 'updated', order:
Order = 'desc') -> list[ModelVersionResponse]:
```

列出对已认证团队可见的模型变体。

参数

 * `model_id` (`UUID | str | None`): 保留属于此模型 UUID 的变体。
 * `name` (`str | None`): 保留具有此名称的变体。
 * `variant_slug` (`str | None`): 保留具有此 slug 的变体。
 * `variant_version` (`str | None`): 保留具有此版本字符串的变体。
 * `is_public` (`bool | None`): 按可见性过滤，或留空 `None` 表示不过滤。
 * `include_model_name` (`bool`): 解析并填充父 `model_name`。这将为每个返回的变体执行一个额外的请求。
 * `limit` (`int`): 要返回的最大变体数量。
 * `sort` (`str`): [ModelVersionResponse](/cloud/hubai/model-registry/hubai-sdk/hubai-sdk-api-reference/utils/sdk_models.md) 用于排序的字段。
 * `order` (`Order`): 按升序或降序排序。

返回

 * `list[ModelVersionResponse]`: 匹配的模型版本资源列表。

### list_variants_cli

```python
def list_variants_cli(model_id: UUID | str | None = None, name: str | None = None, variant_slug: str | None = None,
variant_version: str | None = None, is_public: bool | None = None, include_model_name: bool = False, limit: int = 50, sort: str =
'updated', order: Order = 'desc', field: Annotated[list[str] | None, Parameter(name=['--field', '-f'])] = None):
```

列出 HubAI 中的模型版本。

## 属性

### app

### VARIANT_INFO_KEYS

### VARIANT_LIST_KEYS

### VARIANT_LIST_KEYS_WITH_MODEL
