ai.djl.repository.zoo

Class ModelZoo

java.lang.Object

ai.djl.repository.zoo.ModelZoo

Direct Known Subclasses:

DefaultModelZoo

public abstract class ModelZoo
extends java.lang.Object

An interface represents a collection of models.

Constructor Summary

Constructors

Constructor and Description
ModelZoo()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getGroupId() Returns the global unique identifier of the ModelZoo.
ModelLoader	getModelLoader(java.lang.String name) Returns the ModelLoader based on the model name.
abstract java.util.List<ModelLoader>	getModelLoaders() Lists the available model families in the ModelZoo.
static ModelZoo	getModelZoo(java.lang.String groupId) Returns the ModelZoo with the groupId.
abstract java.util.Set<java.lang.String>	getSupportedEngines() Returns all supported engine names.
static boolean	hasModelZoo(java.lang.String groupId) Returns whether a model zoo with the group id is available.
static java.util.Map<Application,java.util.List<Artifact>>	listModels() Returns the available Application and their model artifact metadata.
static java.util.Map<Application,java.util.List<Artifact>>	listModels(Criteria<?,?> criteria) Returns the available Application and their model artifact metadata.
static java.util.Collection<ModelZoo>	listModelZoo() Returns available model zoos.
static <I,O> ZooModel<I,O>	loadModel(Criteria<I,O> criteria) Load the ZooModel that matches this criteria.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelZoo

public ModelZoo()

Method Detail

getGroupId

public abstract 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

public abstract java.util.List<ModelLoader> getModelLoaders()

Lists the available model families in the ModelZoo.

Returns:

the list of all available model families

getModelLoader

public 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

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

Returns all supported engine names.

Returns:

all supported engine names

listModelZoo

public static java.util.Collection<ModelZoo> listModelZoo()

Returns available model zoos.

Returns:

a list of model zoo

getModelZoo

public static ModelZoo getModelZoo(java.lang.String groupId)

Returns the ModelZoo with the groupId.

Parameters:

groupId - the model zoo group id to check for

Returns:

the ModelZoo with the groupId

hasModelZoo

public static boolean hasModelZoo(java.lang.String groupId)

Returns whether a model zoo with the group id is available.

Parameters:

groupId - the model zoo group id to check for

Returns:

whether a model zoo with the group id is available

loadModel

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

Load the ZooModel that matches this criteria.

Type Parameters:

I - the input data type for preprocessing

O - the output data type after postprocessing

Parameters:

criteria - the requirements for 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

public 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

listModels

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

Returns the available Application and their model artifact metadata.

Parameters:

criteria - the requirements for the model

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