Package ai.djl.repository.zoo

Class BaseModelLoader

java.lang.Object

ai.djl.repository.zoo.BaseModelLoader

All Implemented Interfaces:

ModelLoader

public class BaseModelLoader
extends Object
implements ModelLoader

Shared code for the ModelLoader implementations.

Field Summary

Fields

Modifier and Type	Field	Description
protected TranslatorFactory	defaultFactory
protected MRL	mrl

Constructor Summary

Constructors

Constructor	Description
BaseModelLoader(MRL mrl)	Constructs a ModelLoader given the repository, mrl, and version.

Method Summary

Modifier and Type	Method	Description
protected Model	createModel(Path modelPath, String name, Device device, Block block, Map<String,Object> arguments, String engine)
<I, O> void	downloadModel(Criteria<I,O> criteria, ai.djl.util.Progress progress)	Downloads the model artifacts to local directory.
Application	getApplication()	Returns the application of the ModelLoader.
String	getArtifactId()	Returns the artifact ID of the ModelLoader.
String	getGroupId()	Returns the group ID of the ModelLoader.
protected TranslatorFactory	getTranslatorFactory(Criteria<?,?> criteria, Map<String,Object> arguments)
<I, O> boolean	isDownloaded(Criteria<I,O> criteria)	Returns true if the model is downloaded in local directory.
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.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

mrl

protected MRL mrl

defaultFactory

protected TranslatorFactory defaultFactory

Constructor Details

BaseModelLoader

public BaseModelLoader(MRL mrl)

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

Parameters:

mrl - the mrl of the model to load

Method Details

getGroupId

public String getGroupId()

Returns the group ID of the ModelLoader.

Specified by:

getGroupId in interface ModelLoader

Returns:

the group ID of the ModelLoader

getArtifactId

public 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 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:

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

isDownloaded

public <I,
O> boolean isDownloaded(Criteria<I,O> criteria)
                           throws IOException,
ModelNotFoundException

Returns true if the model is downloaded in local directory.

Specified by:

isDownloaded 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:

true if the model is downloaded in local directory

Throws:

IOException - for various exceptions loading data from the repository

ModelNotFoundException - if no model with the specified criteria is found

downloadModel

public <I,
O> void downloadModel(Criteria<I,O> criteria,
 ai.djl.util.Progress progress)
                         throws IOException,
ModelNotFoundException

Downloads the model artifacts to local directory.

Specified by:

downloadModel 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

progress - the progress tracker

Throws:

IOException - for various exceptions loading data from the repository

ModelNotFoundException - if no model with the specified criteria is found

listModels

public List<Artifact> listModels()
                          throws 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:

IOException - for errors reading the artifact list

createModel

protected Model createModel(Path modelPath,
 String name,
 Device device,
 Block block,
 Map<String,Object> arguments,
 String engine)
                     throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

getTranslatorFactory

protected TranslatorFactory getTranslatorFactory(Criteria<?,?> criteria,
 Map<String,Object> arguments)