ai.djl.repository.zoo

Interface ModelZoo

All Known Implementing Classes:

DefaultModelZoo

public interface ModelZoo

An interface represents a collection of models.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getGroupId() Returns the global unique identifier of the ModelZoo.
default ModelLoader<?,?>	getModelLoader(java.lang.String name) Returns the ModelLoader based on the model name.
default java.util.List<ModelLoader<?,?>>	getModelLoaders() Lists the available model families in the ModelZoo.
java.util.Set<java.lang.String>	getSupportedEngines() Returns all supported engine names.
static java.util.Map<Application,java.util.List<Artifact>>	listModels() Returns the available Application and their model artifact metadata.
static <I,O> ZooModel<I,O>	loadModel(Criteria<I,O> criteria) Gets the ModelLoader based on the model name.

Method Detail

getGroupId

java.lang.String getGroupId()

Returns the global unique identifier of the ModelZoo.

We recommend to use reverse DNS name as your model zoo group ID to make sure it's not conflict with other ModelZoos.

Returns:

the global unique identifier of the ModelZoo

getModelLoaders

default java.util.List<ModelLoader<?,?>> getModelLoaders()

Lists the available model families in the ModelZoo.

Returns:

the list of all available model families

getModelLoader

default ModelLoader<?,?> getModelLoader(java.lang.String name)

Returns the ModelLoader based on the model name.

Parameters:

name - the name of the model

Returns:

the ModelLoader of the model

getSupportedEngines

java.util.Set<java.lang.String> getSupportedEngines()

Returns all supported engine names.

Returns:

all supported engine names

loadModel

static <I,O> ZooModel<I,O> loadModel(Criteria<I,O> criteria)
                              throws java.io.IOException,
                                     ModelNotFoundException,
                                     MalformedModelException

Gets the ModelLoader based on the model name.

Type Parameters:

I - the input data type for preprocessing

O - the output data type after postprocessing

Parameters:

criteria - the name of the model

Returns:

the model that matches the criteria

Throws:

java.io.IOException - for various exceptions loading data from the repository

ModelNotFoundException - if no model with the specified criteria is found

MalformedModelException - if the model data is malformed

listModels

static java.util.Map<Application,java.util.List<Artifact>> listModels()
                                                               throws java.io.IOException,
                                                                      ModelNotFoundException

Returns the available Application and their model artifact metadata.

Returns:

the available Application and their model artifact metadata

Throws:

java.io.IOException - if failed to download to repository metadata

ModelNotFoundException - if failed to parse repository metadata