Model

Model


get_resource_url_on_platform

Signature

get_resource_url_on_platform()

Description

Get platform url of this resource.

Examples

    print(foo_dataset.get_resource_url_on_platform())
    >>> "https://app.picsellia.com/model/62cffb84-b92c-450c-bc37-8c4dd4d0f590"

Returns

Url on Platform for this resource


update

Signature

update(
   name: Optional[str] = None, framework: Union[str, Framework, None] = None,
   private: Optional[bool] = None, description: Optional[str] = None, type: Union[str,
   InferenceType, None] = None
)

Description

Update a model with a new name, framework, privacy, description or type

Examples

    model.update(description="Very cool model")

delete

Signature

delete()

Description

Delete model.

Delete the model in Picsellia database

Examples

    model.delete()

get_tags

Signature

get_tags()

Description

Retrieve the tags of your model.

Examples

    tags = my_model.get_tags()
    assert tags[0].name == "my-model-1"

Returns

List of tags as Tag


create_version

Signature

create_version(
   docker_image_name: Optional[str] = None, docker_flags: Optional[List[str]] = None,
   thumb_object_name: Optional[str] = None, notebook_link: Optional[str] = None,
   labels: Optional[dict] = None, base_parameters: Optional[dict] = None
)

Description

Create a version of a model.

The version number of this model will be defined by the platform. It is incremented automatically.

Examples

    model_v0 = model.create_version()

Returns

A ModelVersion object


get_version

Signature

get_version(
   version: int
)

Description

Retrieve a version of a model

Examples

    version = model.get_version(0)

Returns

A ModelVersion object


list_versions

Signature

list_versions(
   limit: Optional[int] = None, offset: Optional[int] = None,
   order_by: Optional[List[str]] = None
)

Description

List versions of a model

Examples

versions = model.list_versions()

Returns

A list of ModelVersion object of this model