ai.djl.repository.zoo

Class BaseModelLoader<I,O>

java.lang.Object

ai.djl.repository.zoo.BaseModelLoader<I,O>

All Implemented Interfaces:

ModelLoader<I,O>

Direct Known Subclasses:

DefaultModelLoader

public abstract class BaseModelLoader<I,O>
extends java.lang.Object
implements ModelLoader<I,O>

Shared code for the ModelLoader implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<ai.djl.util.Pair<java.lang.reflect.Type,java.lang.reflect.Type>,TranslatorFactory<?,?>>	factories
protected ModelZoo	modelZoo
protected MRL	mrl
protected Repository	repository
protected java.lang.String	version

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseModelLoader(Repository repository, MRL mrl, java.lang.String version, ModelZoo modelZoo) Constructs a ModelLoader given the repository, mrl, and version.

Method Summary

Modifier and Type	Method and Description
protected Model	createModel(java.lang.String name, Device device, Artifact artifact, java.util.Map<java.lang.String,java.lang.Object> arguments, java.lang.String engine)
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.
protected Artifact	match(java.util.Map<java.lang.String,java.lang.String> criteria) Returns the first artifact that matches a given criteria.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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

getApplication, loadModel, loadModel, loadModel, loadModel, loadModel

Field Detail

repository

protected Repository repository

mrl

protected MRL mrl

version

protected java.lang.String version

factories

protected java.util.Map<ai.djl.util.Pair<java.lang.reflect.Type,java.lang.reflect.Type>,TranslatorFactory<?,?>> factories

modelZoo

protected ModelZoo modelZoo

Constructor Detail

BaseModelLoader

protected BaseModelLoader(Repository repository,
                          MRL mrl,
                          java.lang.String version,
                          ModelZoo modelZoo)

Constructs a ModelLoader given the repository, mrl, and version.

Parameters:

repository - the repository to load the model from

mrl - the mrl of the model to load

version - the version of the model to load

modelZoo - the modelZoo type that is being used to get supported engine types

Method Detail

getArtifactId

public java.lang.String getArtifactId()

Returns the artifact ID of the ModelLoader.

Specified by:

getArtifactId in interface ModelLoader<I,O>

Returns:

the artifact ID of the ModelLoader

loadModel

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

Loads the model with the given criteria.

Specified by:

loadModel in interface ModelLoader<I,O>

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

listModels

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

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

Specified by:

listModels in interface ModelLoader<I,O>

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

createModel

protected Model createModel(java.lang.String name,
                            Device device,
                            Artifact artifact,
                            java.util.Map<java.lang.String,java.lang.Object> arguments,
                            java.lang.String engine)
                     throws java.io.IOException

Throws:

java.io.IOException

match

protected Artifact match(java.util.Map<java.lang.String,java.lang.String> criteria)
                  throws java.io.IOException,
                         ModelNotFoundException

Returns the first artifact that matches a given criteria.

Parameters:

criteria - the criteria to match against

Returns:

the first artifact that matches the criteria. Null will be returned if no artifact matches

Throws:

java.io.IOException - for errors while loading the model

ModelNotFoundException - if the metadata to get artifacts from is not found

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object