ai.djl.repository.zoo

Interface ModelLoader<I,O>

Type Parameters:

I - the input data type

O - the output data type

All Known Implementing Classes:

BaseModelLoader, DefaultModelLoader

public interface ModelLoader<I,O>

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

Method Summary

Modifier and Type	Method and 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.
default ZooModel<I,O>	loadModel() Loads the model.
<S,T> ZooModel<S,T>	loadModel(Criteria<S,T> criteria) Loads the model with the given criteria.
default ZooModel<I,O>	loadModel(java.util.Map<java.lang.String,java.lang.String> filters) Loads the model with the given search filters.
ZooModel<I,O>	loadModel(java.util.Map<java.lang.String,java.lang.String> filters, Device device, ai.djl.util.Progress progress) Loads the model with the given search filters.
default ZooModel<I,O>	loadModel(java.util.Map<java.lang.String,java.lang.String> filters, ai.djl.util.Progress progress) Loads the model with the given search filters.
default ZooModel<I,O>	loadModel(ai.djl.util.Progress progress) Loads the model.

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

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

Loads the model with the given criteria.

Type Parameters:

S - the input data type

T - 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

loadModel

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

Loads the 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

loadModel

default ZooModel<I,O> loadModel(ai.djl.util.Progress progress)
                         throws MalformedModelException,
                                ModelNotFoundException,
                                java.io.IOException

Loads the model.

Parameters:

progress - the progress tracker to update while loading the 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

loadModel

default ZooModel<I,O> loadModel(java.util.Map<java.lang.String,java.lang.String> filters)
                         throws MalformedModelException,
                                ModelNotFoundException,
                                java.io.IOException

Loads the model with the given search filters.

Parameters:

filters - the search filters 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

loadModel

default ZooModel<I,O> loadModel(java.util.Map<java.lang.String,java.lang.String> filters,
                                ai.djl.util.Progress progress)
                         throws MalformedModelException,
                                ModelNotFoundException,
                                java.io.IOException

Loads the model with the given search filters.

Parameters:

filters - the search filters to match against the loaded model

progress - the progress tracker to update while loading the 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

loadModel

ZooModel<I,O> loadModel(java.util.Map<java.lang.String,java.lang.String> filters,
                        Device device,
                        ai.djl.util.Progress progress)
                 throws java.io.IOException,
                        ModelNotFoundException,
                        MalformedModelException

Loads the model with the given search filters.

Parameters:

filters - the search filters to match against the loaded model

device - the device the loaded model should use

progress - the progress tracker to update while loading the 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