Package org.pytorch

Class Module

java.lang.Object
org.pytorch.Module
public class Module
extends java.lang.Object
Java wrapper for torch::jit::script::Module.

  • Method Summary

    Modifier and Type Method Description
    void destroy()
    Explicitly destroys the native torch::jit::script::Module.
    IValue forward​(IValue... inputs)
    Runs the 'forward' method of this module with the specified arguments.
    static Module load​(java.lang.String modelPath)
    Loads a serialized TorchScript module from the specified path on the disk.
    IValue runMethod​(java.lang.String methodName, IValue... inputs)
    Runs the specified method of this module with the specified arguments.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • load

      public static Module load​(java.lang.String modelPath)
      Loads a serialized TorchScript module from the specified path on the disk.
      Parameters:
      modelPath - path to file that contains the serialized TorchScript module.
      Returns:
      new Module object which owns torch::jit::script::Module.

    • forward

      public IValue forward​(IValue... inputs)
      Runs the 'forward' method of this module with the specified arguments.
      Parameters:
      inputs - arguments for the TorchScript module's 'forward' method.
      Returns:
      return value from the 'forward' method.

    • runMethod

      public IValue runMethod​(java.lang.String methodName, IValue... inputs)
      Runs the specified method of this module with the specified arguments.
      Parameters:
      methodName - name of the TorchScript method to run.
      inputs - arguments that will be passed to TorchScript method.
      Returns:
      return value from the method.

    • destroy

      public void destroy()
      Explicitly destroys the native torch::jit::script::Module. Calling this method is not required, as the native object will be destroyed when this object is garbage-collected. However, the timing of garbage collection is not guaranteed, so proactively calling destroy can free memory more quickly. See HybridData.resetNative().