ersilia.hub.pull package

Submodules

ersilia.hub.pull.pull module

class ersilia.hub.pull.pull.ModelPuller(model_id: str, overwrite: bool | None = None, config_json: dict | None = None, docker_tag: str | None = None)[source]

Bases: ErsiliaBase

ModelPuller is responsible for pulling models from DockerHub.

Parameters:

  • model_id (str) – The ID of the model to be pulled.

  • overwrite (bool, optional) – Whether to overwrite existing files.

  • config_json (dict, optional) – Configuration settings for the puller.

Examples

puller = ModelPuller(
    model_id="eosxxxx", config_json=config
)
await puller.async_pull()
async_pull(**kwargs)
is_available_in_dockerhub() → bool[source]

Check if the Docker image is available in DockerHub.

Returns:

True if the image is available in DockerHub, False otherwise.

Return type:

bool

is_available_locally() → bool[source]

Check if the Docker image is available locally.

Returns:

True if the image is available locally, False otherwise.

Return type:

bool

pull(**kwargs)

Module contents