furiosa.registry.client package

Subpackages

• furiosa.registry.client.transport package
  • Submodules
  • furiosa.registry.client.transport.base module
  • furiosa.registry.client.transport.file module
  • furiosa.registry.client.transport.github module
  • furiosa.registry.client.transport.http module
  • furiosa.registry.client.transport.s3 module
  • Module contents

Module contents

FuriosaAI registry client.

async furiosa.registry.client.help(uri: str, name: str, version: Optional[str] = None) → str

Show the documentation for the model

Parameters

• uri (str) – Registry URI which have a descriptor file (artifacts.py).

• name (str) – Model name in a descriptor file.

• version (Optional[str]) – Model version to be created.

Returns

Documentation string for the model.

Return type

str

Raises

ModuleNotFoundError – If descriptor file not found in the registry.

async furiosa.registry.client.list(uri: str) → List[str]

List Artifacts from the specified registry URI.

Parameters

uri (str) – Registry URI which have a descriptor file (artifacts.py).

Returns

Available model names in the registry

Return type

List[str]

Raises

ModuleNotFoundError – If descriptor file not found in the registry.

async furiosa.registry.client.load(uri: str, name: str, *args: Any, **kwargs: Any) → Optional[furiosa.registry.model.Model]

Load models from the specified registry URI.

Parameters

• uri (str) – Registry URI which have a descriptor file (artifacts.py).

• name (str) – Model name in a descriptor file.

• kwargs (args,) – Arguments for Model instantiation.

Returns

A model loaded from the registry.

Return type

Model

Raises

ModuleNotFoundError – If descriptor file not found in the registry.