ai.djl.repository.zoo

Class BaseModelLoader

java.lang.Object

ai.djl.repository.zoo.BaseModelLoader

All Implemented Interfaces:

ModelLoader

Direct Known Subclasses:

ActionRecognitionModelLoader, ImageClassificationModelLoader, InstanceSegmentationModelLoader, ObjectDetectionModelLoader, SimplePoseModelLoader

public class BaseModelLoader
extends java.lang.Object
implements ModelLoader

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 Resource	resource

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)
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

factories

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

modelZoo

protected ModelZoo modelZoo

resource

protected Resource resource

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

Returns:

the artifact ID of the ModelLoader

getApplication

public Application getApplication()

Returns the application of the ModelLoader.

Specified by:

getApplication in interface ModelLoader

Returns:

the application of the ModelLoader

loadModel

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

Loads the model with the given criteria.

Specified by:

loadModel in interface ModelLoader

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

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

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

Specified by:

listModels in interface ModelLoader

Returns:

a list of the available artifacts that can be loaded

Throws:

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

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object