Skip to main content

Models catalog

This article refers to SDK version v0.5.0. The current SDK version is N/A.

Mounted at client.models. The model catalog works the same way as the application catalog, but for ML model artifacts deployed to run inference at the edge. See the Overview for narrative examples, and Models for the equivalent Panel actions.

Concept

Model. A machine learning artifact an operator registers and deploys from Barbara Panel the same way as an application, so it runs inference at the edge instead of in a central cloud.

Learn more

ModelsResource​

ModelsResource(client: BarbaraClient)

list​

list() -> List[MLModel]

get​

get(model_id: str) -> MLModel

create​

create(
    name: str,
    long_description: str,
    developer: str,
    *,
    model_type: int,
    engine: int,
    short_description: Optional[str] = None,
    icon_path: Optional[str] = None,
    timeout: Optional[float] = None,
) -> None

update​

update(
    model_id: str,
    *,
    name: Optional[str] = None,
    long_description: Optional[str] = None,
    short_description: Optional[str] = None,
    developer: Optional[str] = None,
) -> None

delete​

delete(model_id: str) -> None

list_versions​

list_versions(model_id: str) -> List[ModelVersion]

create_version​

create_version(
    model_id: str,
    artifact_path: str,
    name: str,
    release_notes: List[str],
    *,
    timeout: Optional[float] = None,
) -> None

rename_version​

rename_version(model_id: str, model_version_id: str, name: str) -> None

delete_version​

delete_version(model_id: str, model_version_id: str) -> None

AsyncModelsResource​

AsyncModelsResource(client: AsyncBarbaraClient)

list​

list() -> List[MLModel]

get​

get(model_id: str) -> MLModel

create​

create(
    name: str,
    long_description: str,
    developer: str,
    *,
    model_type: int,
    engine: int,
    short_description: Optional[str] = None,
    icon_path: Optional[str] = None,
    timeout: Optional[float] = None,
) -> None

update​

update(
    model_id: str,
    *,
    name: Optional[str] = None,
    long_description: Optional[str] = None,
    short_description: Optional[str] = None,
    developer: Optional[str] = None,
) -> None

delete​

delete(model_id: str) -> None

list_versions​

list_versions(model_id: str) -> List[ModelVersion]

create_version​

create_version(
    model_id: str,
    artifact_path: str,
    name: str,
    release_notes: List[str],
    *,
    timeout: Optional[float] = None,
) -> None

rename_version​

rename_version(model_id: str, model_version_id: str, name: str) -> None

delete_version​

delete_version(model_id: str, model_version_id: str) -> None

Signatures above are generated from barbara-api-sdk 0.5.0 docstrings. If a new SDK release changes one, this page needs a re-sync — the surrounding prose does not update itself.