ai.djl.repository.zoo

Class LocalModelLoader

java.lang.Object

ai.djl.repository.zoo.LocalModelLoader

All Implemented Interfaces:

ModelLoader<ai.djl.ndarray.NDList,ai.djl.ndarray.NDList>

public class LocalModelLoader
extends java.lang.Object
implements ModelLoader<ai.djl.ndarray.NDList,ai.djl.ndarray.NDList>

A ModelLoader loads a particular ZooModel from a local folder.

Constructor Summary

Constructors

Constructor and Description
LocalModelLoader(Repository repository) Creates the model loader from the given repository.

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.djl.repository.zoo.ModelLoader

loadModel, loadModel, loadModel, loadModel

Constructor Detail

LocalModelLoader

public LocalModelLoader(Repository repository)

Creates the model loader from the given repository.

Parameters:

repository - the repository to load the model from

Method Detail

getArtifactId

public java.lang.String getArtifactId()

Returns the artifact ID of the ModelLoader.

Specified by:

getArtifactId in interface ModelLoader<ai.djl.ndarray.NDList,ai.djl.ndarray.NDList>

Returns:

the artifact ID of the ModelLoader

getApplication

public ai.djl.Application getApplication()

Returns the application of the ModelLoader.

Specified by:

getApplication in interface ModelLoader<ai.djl.ndarray.NDList,ai.djl.ndarray.NDList>

Returns:

the application of the ModelLoader

loadModel

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

Loads the model with the given criteria.

Specified by:

loadModel in interface ModelLoader<ai.djl.ndarray.NDList,ai.djl.ndarray.NDList>

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

ai.djl.MalformedModelException - if the model data is malformed

loadModel

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

Loads the model with the given search filters.

Specified by:

loadModel in interface ModelLoader<ai.djl.ndarray.NDList,ai.djl.ndarray.NDList>

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

ai.djl.MalformedModelException - if the model data is malformed

listModels

public java.util.List<Artifact> listModels()

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

Specified by:

listModels in interface ModelLoader<ai.djl.ndarray.NDList,ai.djl.ndarray.NDList>

Returns:

a list of the available artifacts that can be loaded