Package ai.djl.repository.zoo

Interface ModelLoader

All Known Implementing Classes:

BaseModelLoader

public interface ModelLoader

A ModelLoader loads a particular ZooModel from a Repository for a model zoo.

Method Summary

Modifier and Type	Method	Description
Application	getApplication()	Returns the application of the ModelLoader.
java.lang.String	getArtifactId()	Returns the artifact ID of the ModelLoader.
java.util.List<Artifact>	listModels()	Returns a list of the available artifacts that can be loaded.
<I,O> ZooModel<I,O>	loadModel(Criteria<I,O> criteria)	Loads the model with the given criteria.

Method Detail

getArtifactId

java.lang.String getArtifactId()

Returns the artifact ID of the ModelLoader.

Returns:

the artifact ID of the ModelLoader

getApplication

Application getApplication()

Returns the application of the ModelLoader.

Returns:

the application of the ModelLoader

loadModel

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

Loads the model with the given criteria.

Type Parameters:

I - the input data type

O - the output data type

Parameters:

criteria - the criteria to match against the loaded model

Returns:

the loaded model

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

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

Returns a list of the available artifacts that can be loaded.

Returns:

a list of the available artifacts that can be loaded

Throws:

java.io.IOException - for errors reading the artifact list

ModelNotFoundException - if models with the mrl defined within this loader are found