hubai_sdk.services.variants

module documentation

Undocumented

Function create_variant Creates a new variant of a model.
Function create_variant_cli Creates a new variant of a model.
Function delete_variant Deletes a model variant.
Function delete_variant_cli Deletes a model variant.
Function get_variant Returns information about a model version.
Function get_variant_info_cli Returns information about a model version.
Function list_variants List the model versions in the HubAI.
Function list_variants_cli List the model versions in the HubAI.
Constant VARIANT_INFO_KEYS Undocumented
Constant VARIANT_LIST_KEYS Undocumented
Constant VARIANT_LIST_KEYS_WITH_MODEL Undocumented
Variable app Undocumented
Function _print_variant_info Undocumented
Function _print_variant_list Undocumented
Function _variant_to_cli_data Undocumented
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:

Creates a new variant of a model.

Parameters
name:strstr. The name of the model variant.
model_id:UUID | strUUID | str. The ID of the model to create a variant for.
variant_version:strstr. The version of the model variant.
description:str | Nonestr | None. Full description of the model variant.
repository_url:str | Nonestr | None. URL of the related repository.
commit_hash:str | Nonestr | None. Commit hash.
domain:str | Nonestr | None. Domain of the model variant.
tags:list[str] | Nonelist[str] | None. List of tags for the model variant.
Returns
ModelVersionResponseThe created model version resource.
@app.command(name='create')
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):

Creates a new variant of a model.

@telemetry_operation(OperationTelemetrySpec(operation_name=OperationName.VARIANT_DELETE, operation_group=TelemetryGroup.VARIANTS, success_event=VARIANT_DELETED_EVENT, target_resource=TargetResource.VARIANT, identifier_param='identifier', success_builder=build_model_identifier_properties))
def delete_variant(identifier: UUID | str):

Deletes a model variant.

Parameters
identifier:UUID | strUUID | str. The model variant ID or slug.
@app.command(name='delete')
def delete_variant_cli(identifier: UUID | str):

Deletes a model variant.

@telemetry_operation(OperationTelemetrySpec(operation_name=OperationName.VARIANT_GET, operation_group=TelemetryGroup.VARIANTS, success_event=VARIANT_RETRIEVED_EVENT, target_resource=TargetResource.VARIANT, identifier_param='identifier', success_builder=build_model_identifier_properties))
def get_variant(identifier: UUID | str) -> ModelVersionResponse:

Returns information about a model version.

Parameters
identifier:UUID | strUUID | str. The model version ID or slug.
Returns
ModelVersionResponseThe resolved model version resource.
@app.command(name='info')
def get_variant_info_cli(identifier: UUID | str):

Returns information about a model version.

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]:

List the model versions in the HubAI.

Parameters
model_id:UUID | str | NoneUUID | str | None. Filter the listed model versions by model ID.
name:str | Nonestr | None. Filter the listed model versions by name.
variant_slug:str | Nonestr | None. Filter the listed model versions by variant slug.
variant_version:str | Nonestr | None. Filter the listed model versions by version.
is_public:bool | Nonebool | None. Filter the listed model versions by visibility.
include_model_name:boolbool. Whether to include the model name in the response. By default, it is False and the ModelVersionResponse will have "model_name" field as None. If True, the ModelVersionResponse will have "model_name" field as the name of the model.
limit:intint. Limit the number of model versions to show.
sort:strstr. Sort the model versions by this field. It should be the field name from the ModelVersionResponse. For example, "name", "id", "updated", etc.
order:OrderLiteral["asc", "desc"]. Order to sort the model versions by. It should be "asc" or "desc".
Returns
list[ModelVersionResponse]A list of matching model version resources.
@app.command(name='ls')
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):

List the model versions in the HubAI.

VARIANT_INFO_KEYS: list[str] =

Undocumented

Value
['model_name',
 'name',
 'slug',
 'version',
 'id',
 'model_id',
 'created',
...
VARIANT_LIST_KEYS: list[str] =

Undocumented

Value
['name', 'version', 'id', 'platforms']
VARIANT_LIST_KEYS_WITH_MODEL: list[str] =

Undocumented

Value
['model_name', 'name', 'version', 'id', 'platforms']
app =

Undocumented

def _print_variant_info(variant: ModelVersionResponse):

Undocumented

def _print_variant_list(variants: list[ModelVersionResponse], include_model_name: bool, field: list[str] | None = None):

Undocumented

def _variant_to_cli_data(variant: ModelVersionResponse) -> dict[str, object]:

Undocumented