Package ai.djl

Class BaseModel

java.lang.Object
ai.djl.BaseModel
All Implemented Interfaces:
Model, AutoCloseable
public abstract class BaseModel extends Object implements Model
BaseModel is the basic implementation of Model.

  • Field Details

    • modelDir

      protected Path modelDir

    • block

      protected Block block

    • modelName

      protected String modelName

    • manager

      protected NDManager manager

    • dataType

      protected DataType dataType

    • wasLoaded

      protected boolean wasLoaded

    • inputData

      protected ai.djl.util.PairList<String,Shape> inputData

    • artifacts

      protected Map<String,Object> artifacts

    • properties

      protected Map<String,String> properties

  • Constructor Details

    • BaseModel

      protected BaseModel(String modelName)

  • Method Details

    • getBlock

      public Block getBlock()
      Gets the block from the Model.
      Specified by:
      getBlock in interface Model
      Returns:
      the Block

    • setBlock

      public void setBlock(Block block)
      Sets the block for the Model for training and inference.
      Specified by:
      setBlock in interface Model
      Parameters:
      block - the Block used in Model

    • getName

      public String getName()
      Gets the model name.
      Specified by:
      getName in interface Model
      Returns:
      name of the model

    • getNDManager

      public NDManager getNDManager()
      Gets the NDManager from the model.
      Specified by:
      getNDManager in interface Model
      Returns:
      the NDManager

    • newTrainer

      public Trainer newTrainer(TrainingConfig trainingConfig)
      Creates a new Trainer instance for a Model.
      Specified by:
      newTrainer in interface Model
      Parameters:
      trainingConfig - training configuration settings
      Returns:
      the Trainer instance

    • newPredictor

      public <I, O> Predictor<I,O> newPredictor(Translator<I,O> translator, Device device)
      Creates a new Predictor based on the model.
      Specified by:
      newPredictor in interface Model
      Type Parameters:
      I - the input object for pre-processing
      O - the output object from postprocessing
      Parameters:
      translator - the object used for pre-processing and postprocessing
      device - the device to use for prediction
      Returns:
      an instance of Predictor

    • setDataType

      public void setDataType(DataType dataType)
      Sets the standard data type used within the model.
      Specified by:
      setDataType in interface Model
      Parameters:
      dataType - the standard data type to use

    • getDataType

      public DataType getDataType()
      Returns the standard data type used within the model.
      Specified by:
      getDataType in interface Model
      Returns:
      the standard data type used within the model

    • load

      public void load(InputStream is, Map<String,?> options) throws IOException, MalformedModelException
      Loads the model from the InputStream with the options provided.
      Specified by:
      load in interface Model
      Parameters:
      is - the InputStream to load the model from
      options - engine specific load model options, see documentation for each engine
      Throws:
      IOException - when IO operation fails in loading a resource
      MalformedModelException - if model file is corrupted

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Model

    • describeInput

      public ai.djl.util.PairList<String,Shape> describeInput()
      Returns the input descriptor of the model.

      It contains the information that can be extracted from the model, usually name, shape, layout and DataType.

      Specified by:
      describeInput in interface Model
      Returns:
      a PairList of String and Shape

    • describeOutput

      public ai.djl.util.PairList<String,Shape> describeOutput()
      Returns the output descriptor of the model.

      It contains the output information that can be obtained from the model.

      Specified by:
      describeOutput in interface Model
      Returns:
      a PairList of String and Shape

    • getArtifactNames

      public String[] getArtifactNames()
      Returns the artifact names associated with the model.
      Specified by:
      getArtifactNames in interface Model
      Returns:
      an array of artifact names

    • getArtifact

      public <T> T getArtifact(String name, Function<InputStream,T> function) throws IOException
      Attempts to load the artifact using the given function and cache it if the specified artifact is not already cached.

      Model will cache loaded artifact, so the user doesn't need to keep tracking it. 

      
 String synset = model.getArtifact("synset.txt", k -> IOUtils.toString(k)));
      Specified by:
      getArtifact in interface Model
      Type Parameters:
      T - the type of the returned artifact object
      Parameters:
      name - the name of the desired artifact
      function - the function to load the artifact
      Returns:
      the current (existing or computed) artifact associated with the specified name, or null if the computed value is null
      Throws:
      IOException - when IO operation fails in loading a resource

    • getArtifact

      public URL getArtifact(String artifactName) throws IOException
      Finds an artifact resource with a given name in the model.
      Specified by:
      getArtifact in interface Model
      Parameters:
      artifactName - the name of the desired artifact
      Returns:
      a URL object or null if no artifact with this name is found
      Throws:
      IOException - when IO operation fails in loading a resource

    • getArtifactAsStream

      public InputStream getArtifactAsStream(String name) throws IOException
      Finds an artifact resource with a given name in the model.
      Specified by:
      getArtifactAsStream in interface Model
      Parameters:
      name - the name of the desired artifact
      Returns:
      a InputStream object or null if no resource with this name is found
      Throws:
      IOException - when IO operation fails in loading a resource

    • setProperty

      public void setProperty(String key, String value)
      Sets a property to the model.

      properties will be saved/loaded with model, user can store some information about the model in here.

      Specified by:
      setProperty in interface Model
      Parameters:
      key - the name of the property
      value - the value of the property

    • getProperty

      public String getProperty(String key)
      Returns the property of the model based on property name.
      Specified by:
      getProperty in interface Model
      Parameters:
      key - the name of the property
      Returns:
      the value of the property

    • getProperties

      public Map<String,String> getProperties()
      Returns the model's properties.
      Specified by:
      getProperties in interface Model
      Returns:
      the model's properties

    • setModelDir

      protected void setModelDir(Path modelDir)

    • save

      public void save(Path modelPath, String newModelName) throws IOException
      Saves the model to the specified modelPath with the name provided.
      Specified by:
      save in interface Model
      Parameters:
      modelPath - the directory or file path of the model location
      newModelName - the new model name to be saved, use null to keep original model name
      Throws:
      IOException - when IO operation fails in loading a resource

    • getModelPath

      public Path getModelPath()
      Returns the directory from where the model is loaded.
      Specified by:
      getModelPath in interface Model
      Returns:
      the directory of the model location

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • finalize

      protected void finalize() throws Throwable
      Overrides:
      finalize in class Object
      Throws:
      Throwable

    • paramPathResolver

      protected Path paramPathResolver(String prefix, Map<String,?> options) throws IOException
      Throws:
      IOException

    • readParameters

      protected boolean readParameters(Path paramFile, Map<String,?> options) throws IOException, MalformedModelException
      Throws:
      IOException
      MalformedModelException