ai.djl.repository.zoo

Class ZooModel<I,O>

java.lang.Object

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

Type Parameters:

I - the model input type

O - the model output type

All Implemented Interfaces:

ai.djl.Model, java.lang.AutoCloseable

public class ZooModel<I,O>
extends java.lang.Object
implements ai.djl.Model

A ZooModel is a Model loaded from a model zoo and includes a default Translator.

Constructor Summary

Constructors

Constructor and Description
ZooModel(ai.djl.Model model, ai.djl.translate.Translator<I,O> translator) Constructs a ZooModel given the model and translator.

Method Summary

Modifier and Type	Method and Description
void	cast(ai.djl.ndarray.types.DataType dataType)
void	close()
ai.djl.util.PairList<java.lang.String,ai.djl.ndarray.types.Shape>	describeInput()
ai.djl.util.PairList<java.lang.String,ai.djl.ndarray.types.Shape>	describeOutput()
java.net.URL	getArtifact(java.lang.String name)
<T> T	getArtifact(java.lang.String name, java.util.function.Function<java.io.InputStream,T> function)
java.io.InputStream	getArtifactAsStream(java.lang.String name)
java.lang.String[]	getArtifactNames()
ai.djl.nn.Block	getBlock()
ai.djl.ndarray.types.DataType	getDataType()
java.lang.String	getName()
ai.djl.ndarray.NDManager	getNDManager()
java.lang.String	getProperty(java.lang.String key)
ai.djl.translate.Translator<I,O>	getTranslator() Returns the default translator.
void	load(java.nio.file.Path modelPath, java.lang.String modelName, java.util.Map<java.lang.String,java.lang.String> options)
ai.djl.inference.Predictor<I,O>	newPredictor() Creates a new Predictor based on the model with the default translator.
<P,Q> ai.djl.inference.Predictor<P,Q>	newPredictor(ai.djl.translate.Translator<P,Q> translator)
ai.djl.training.Trainer	newTrainer(ai.djl.training.TrainingConfig trainingConfig)
void	save(java.nio.file.Path modelPath, java.lang.String modelName)
void	setBlock(ai.djl.nn.Block block)
void	setDataType(ai.djl.ndarray.types.DataType dataType)
void	setProperty(java.lang.String key, java.lang.String value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.djl.Model

load, load, newInstance, newInstance, newInstance, quantize

Constructor Detail

ZooModel

public ZooModel(ai.djl.Model model,
                ai.djl.translate.Translator<I,O> translator)

Constructs a ZooModel given the model and translator.

Parameters:

model - the model to wrap

translator - the translator

Method Detail

load

public void load(java.nio.file.Path modelPath,
                 java.lang.String modelName,
                 java.util.Map<java.lang.String,java.lang.String> options)

Specified by:

load in interface ai.djl.Model

save

public void save(java.nio.file.Path modelPath,
                 java.lang.String modelName)
          throws java.io.IOException

Specified by:

save in interface ai.djl.Model

Throws:

java.io.IOException

getBlock

public ai.djl.nn.Block getBlock()

Specified by:

getBlock in interface ai.djl.Model

setBlock

public void setBlock(ai.djl.nn.Block block)

Specified by:

setBlock in interface ai.djl.Model

getName

public java.lang.String getName()

Specified by:

getName in interface ai.djl.Model

getProperty

public java.lang.String getProperty(java.lang.String key)

Specified by:

getProperty in interface ai.djl.Model

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Specified by:

setProperty in interface ai.djl.Model

newTrainer

public ai.djl.training.Trainer newTrainer(ai.djl.training.TrainingConfig trainingConfig)

Specified by:

newTrainer in interface ai.djl.Model

newPredictor

public ai.djl.inference.Predictor<I,O> newPredictor()

Creates a new Predictor based on the model with the default translator.

Returns:

an instance of Predictor

newPredictor

public <P,Q> ai.djl.inference.Predictor<P,Q> newPredictor(ai.djl.translate.Translator<P,Q> translator)

Specified by:

newPredictor in interface ai.djl.Model

getTranslator

public ai.djl.translate.Translator<I,O> getTranslator()

Returns the default translator.

Returns:

the default translator

describeInput

public ai.djl.util.PairList<java.lang.String,ai.djl.ndarray.types.Shape> describeInput()

Specified by:

describeInput in interface ai.djl.Model

describeOutput

public ai.djl.util.PairList<java.lang.String,ai.djl.ndarray.types.Shape> describeOutput()

Specified by:

describeOutput in interface ai.djl.Model

getArtifactNames

public java.lang.String[] getArtifactNames()

Specified by:

getArtifactNames in interface ai.djl.Model

getArtifact

public <T> T getArtifact(java.lang.String name,
                         java.util.function.Function<java.io.InputStream,T> function)
                  throws java.io.IOException

Specified by:

getArtifact in interface ai.djl.Model

Throws:

java.io.IOException

getArtifact

public java.net.URL getArtifact(java.lang.String name)
                         throws java.io.IOException

Specified by:

getArtifact in interface ai.djl.Model

Throws:

java.io.IOException

getArtifactAsStream

public java.io.InputStream getArtifactAsStream(java.lang.String name)
                                        throws java.io.IOException

Specified by:

getArtifactAsStream in interface ai.djl.Model

Throws:

java.io.IOException

getNDManager

public ai.djl.ndarray.NDManager getNDManager()

Specified by:

getNDManager in interface ai.djl.Model

setDataType

public void setDataType(ai.djl.ndarray.types.DataType dataType)

Specified by:

setDataType in interface ai.djl.Model

getDataType

public ai.djl.ndarray.types.DataType getDataType()

Specified by:

getDataType in interface ai.djl.Model

cast

public void cast(ai.djl.ndarray.types.DataType dataType)

Specified by:

cast in interface ai.djl.Model

close

public void close()

Specified by:

close in interface ai.djl.Model

Specified by:

close in interface java.lang.AutoCloseable