xnn.common.models.hub.registry.register_pretrained#

xnn.common.models.hub.registry.register_pretrained(card=None, **fields)[source]#

Add a model to the registry (for this process).

Parameters:

card (ModelCard or dict, optional) – The card. Keyword arguments are merged on top, so register_pretrained(name="my-model", doi="10.5281/zenodo.123") works too.
**fields – Card fields.

Returns:

The registered card.

Return type:

ModelCard

Raises:

ValueError – If the name is not a safe cache key (letters, digits, ._-, with / between parts).