axip.ailia

Class AiliaModel

java.lang.Object

axip.ailia.AiliaModel

All Implemented Interfaces:

java.lang.AutoCloseable

public class AiliaModel
extends java.lang.Object
implements java.lang.AutoCloseable

Wrapper class for Ailia.

Constructor Summary

Constructors

Constructor and Description
AiliaModel(int envId, int numThread, byte[] streamData, byte[] weightData) Constructor
AiliaModel(int envId, int numThread, java.util.EnumSet<AiliaMemoryMode> memoryMode, boolean layerFusion, byte[] streamData, byte[] weightData) Constructor
AiliaModel(int envId, int numThread, java.util.EnumSet<AiliaMemoryMode> memoryMode, boolean layerFusion, java.lang.String streamPath, java.lang.String weightPath) Constructor
AiliaModel(int envId, int numThread, java.util.EnumSet<AiliaMemoryMode> memoryMode, byte[] streamData, byte[] weightData) Constructor
AiliaModel(int envId, int numThread, java.util.EnumSet<AiliaMemoryMode> memoryMode, java.lang.String streamPath, java.lang.String weightPath) Constructor
AiliaModel(int envId, int numThread, java.lang.String streamPath, java.lang.String weightPath) Constructor

Method Summary

Modifier and Type	Method and Description
void	close() It destroys the network instance.
void	copyBlob(int dstBlobIndex, int srcBlobIndex, AiliaModel srcNet) Copy blobs between specified models.
AiliaClassifierModel	createClassifier(AiliaNetworkImageFormat format, AiliaNetworkImageChannel channel, AiliaNetworkImageRange range) Creates a classifier object.
AiliaDetectorModel	createDetector(AiliaNetworkImageFormat format, AiliaNetworkImageChannel channel, AiliaNetworkImageRange range, AiliaDetectorAlgorithm algorithm, int categoryCount, java.util.EnumSet<AiliaDetectorFlags> flags) Creates a detector object.
AiliaDetectorModel	createDetector(AiliaNetworkImageFormat format, AiliaNetworkImageChannel channel, AiliaNetworkImageRange range, int algorithm, int categoryCount, int flags) Deprecated. Please use #createDetector(AiliaNetworkImageFormat, AiliaNetworkImageChannel, AiliaNetworkImageRange, AiliaDetectorAlgorithm, int, EnumSet)
AiliaFeatureExtractorModel	createFeatureExtractor(AiliaNetworkImageFormat format, AiliaNetworkImageChannel channel, AiliaNetworkImageRange range, java.lang.String layerName) Creates a feature extractor object.
AiliaPoseEstimatorModel	createPoseEstimator(AiliaPoseEstimatorAlgorithm algorithm) Creates a pose estimator object.
AiliaPoseEstimatorModel	createPoseEstimator(int algorithm) Deprecated. Psease use createPoseEstimator(AiliaPoseEstimatorAlgorithm)
void	getBlobData(float[] dest, int destSize, int idx) Get the output blob data.
int	getBlobIndexByInputIndex(int inputBlobIndex) Get the blob index of the input data.
int	getBlobIndexByOutputIndex(int outputBlobIndex) Get the blob index of the output data blob.
AiliaShape	getBlobShape(int blobIndex) Gets the shape of the internal data (blob) during inference.
int[]	getBlobShapeND(int blobIndex) Gets the shape of the internal data (blob) during inference.
static java.util.List<AiliaEnvironment>	getEnvironments() Gets the available computational environments.
long	getHandle() Gets A network instance handle
int	getInputBlobCount() Get the number of input data blobs.
AiliaShape	getInputShape() Gets the shape of the input data during inference.
int[]	getInputShapeND() Gets the shape of the input data during inference.
static java.util.EnumSet<AiliaMemoryMode>	getMemoryMode(boolean reduceConstant, boolean ignoreInputWithInitializer, boolean reduceInterstage, boolean reuseInterstage) Create mode flags for Ailia.SetMemoryMode(long, int) / Constructor.
int	getOutputBlobCount() Get the number of output data blobs.
AiliaShape	getOutputShape() Gets the shape of the output data during inference.
int[]	getOutputShapeND() Gets the shape of the output data during inference.
java.lang.String	getSummary() Shows the name and shape of each blob.
void	predict(float[] dest, int destSize, float[] src, int srcSize) Performs the inferences and provides the inference result.
void	Predict(float[] dest, int destSize, float[] src, int srcSize) Deprecated. Psease use predict(float[], int, float[], int)
void	setInputBlobData(float[] src, int srcSize, int idx) Set the input blob data.
void	setInputBlobShape(AiliaShape shape, int blobIndex, int version) Change the shape of the blob given by its index
void	setInputBlobShapeND(int[] shape, int blobIndex) Change the shape of the blob given by its index
void	setInputShape(AiliaShape shape) Changes the shape of the input data during inference.
void	setInputShapeND(int[] shape) Changes the shape of the input data during inference.
void	setProfileMode(AiliaProfileMode profileMode) Set the profile mode.
void	update() Performs the inferences

Methods inherited from class java.lang.Object

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

Constructor Detail

AiliaModel

public AiliaModel(int envId,
                  int numThread,
                  byte[] streamData,
                  byte[] weightData)
           throws AiliaException

Constructor

Parameters:

envId - The ID of the inference backend used for computation (obtained by getEnvironments())

numThread - The upper limit on the number of threads

streamData - An array of the data in the protobuf file

weightData - An array of the data in the protobuf/onnx file

Throws:

AiliaException - Exception

See Also:

Ailia.Create(int, int), Ailia.OpenStreamMem(long, byte[], int), Ailia.OpenWeightMem(long, byte[], int)

AiliaModel

public AiliaModel(int envId,
                  int numThread,
                  java.lang.String streamPath,
                  java.lang.String weightPath)
           throws AiliaException

Constructor

Parameters:

envId - The ID of the inference backend used for computation (obtained by getEnvironments())

numThread - The upper limit on the number of threads

streamPath - The path name to the prototxt file

weightPath - The path name to the protobuf/onnx file

Throws:

AiliaException - Exception

See Also:

Ailia.Create(int, int), Ailia.OpenStreamFile(long, String), Ailia.OpenWeightFile(long, String)

AiliaModel

public AiliaModel(int envId,
                  int numThread,
                  java.util.EnumSet<AiliaMemoryMode> memoryMode,
                  byte[] streamData,
                  byte[] weightData)
           throws AiliaException

Constructor

Parameters:

envId - The ID of the inference backend used for computation (obtained by getEnvironments())

numThread - The upper limit on the number of threads

memoryMode - Memory mode (Calucurate by getMemoryMode(boolean, boolean, boolean, boolean))

streamData - An array of the data in the protobuf file

weightData - An array of the data in the protobuf/onnx file

Throws:

AiliaException - Exception

See Also:

Ailia.Create(int, int), Ailia.OpenStreamMem(long, byte[], int), Ailia.OpenWeightMem(long, byte[], int)

AiliaModel

public AiliaModel(int envId,
                  int numThread,
                  java.util.EnumSet<AiliaMemoryMode> memoryMode,
                  java.lang.String streamPath,
                  java.lang.String weightPath)
           throws AiliaException

Constructor

Parameters:

envId - The ID of the inference backend used for computation (obtained by getEnvironments())

numThread - The upper limit on the number of threads

memoryMode - Memory mode (Calucurate by getMemoryMode(boolean, boolean, boolean, boolean))

streamPath - The path name to the prototxt file

weightPath - The path name to the protobuf/onnx file

Throws:

AiliaException - Exception

See Also:

Ailia.Create(int, int), Ailia.OpenStreamFile(long, String), Ailia.OpenWeightFile(long, String)

AiliaModel

public AiliaModel(int envId,
                  int numThread,
                  java.util.EnumSet<AiliaMemoryMode> memoryMode,
                  boolean layerFusion,
                  byte[] streamData,
                  byte[] weightData)
           throws AiliaException

Constructor

Parameters:

envId - The ID of the inference backend used for computation (obtained by getEnvironments())

numThread - The upper limit on the number of threads

memoryMode - Memory mode (Calucurate by getMemoryMode(boolean, boolean, boolean, boolean))

layerFusion - Enable or disable layer fusion optimization

streamData - An array of the data in the protobuf file

weightData - An array of the data in the protobuf/onnx file

Throws:

AiliaException

See Also:

Ailia#Create(int, int)}, Ailia#OpenStreamMem(long, byte[], int)}, Ailia#OpenWeightMem(long, byte[], int)}

AiliaModel

public AiliaModel(int envId,
                  int numThread,
                  java.util.EnumSet<AiliaMemoryMode> memoryMode,
                  boolean layerFusion,
                  java.lang.String streamPath,
                  java.lang.String weightPath)
           throws AiliaException

Constructor

Parameters:

envId - The ID of the inference backend used for computation (obtained by getEnvironments())

numThread - The upper limit on the number of threads

memoryMode - Memory mode (Calucurate by getMemoryMode(boolean, boolean, boolean, boolean))

layerFusion - Enable or disable layer fusion optimization

streamPath - The path name to the prototxt file

weightPath - The path name to the protobuf/onnx file

Throws:

AiliaException

See Also:

Ailia#Create(int, int)}, Ailia#OpenStreamFile(long, String)}, Ailia#OpenWeightFile(long, String)}

Method Detail

getEnvironments

public static java.util.List<AiliaEnvironment> getEnvironments()
                                                        throws AiliaException

Gets the available computational environments.

Returns:

List of Environment

Throws:

AiliaException - Exception

getMemoryMode

public static java.util.EnumSet<AiliaMemoryMode> getMemoryMode(boolean reduceConstant,
                                                               boolean ignoreInputWithInitializer,
                                                               boolean reduceInterstage,
                                                               boolean reuseInterstage)
                                                        throws AiliaException

Create mode flags for Ailia.SetMemoryMode(long, int) / Constructor.

Parameters:

reduceConstant - Releases the intermediate buffer that is a constant such as weight

ignoreInputWithInitializer - Disable the input specified initializer and release the intermediate buffer that becomes a constant such as weight.

reduceInterstage - Release intermediate buffer during inference

reuseInterstage - Infer by sharing the intermediate buffer.

Returns:

Enum set of AiliaMemoryMode

Throws:

AiliaException - Exception

See Also:

Ailia.SetMemoryMode(long, int)

createClassifier

public AiliaClassifierModel createClassifier(AiliaNetworkImageFormat format,
                                             AiliaNetworkImageChannel channel,
                                             AiliaNetworkImageRange range)
                                      throws AiliaException

Creates a classifier object.

Parameters:

format - The network image format (AiliaNetworkImageFormat)

channel - The network image channel (AiliaNetworkImageChannel)

range - The network image range (AiliaNetworkImageRange)

Returns:

The instance of a classfier wrapper class.

Throws:

AiliaException - Exception

See Also:

AiliaClassifier.Create(long, int, int, int)

createDetector

public AiliaDetectorModel createDetector(AiliaNetworkImageFormat format,
                                         AiliaNetworkImageChannel channel,
                                         AiliaNetworkImageRange range,
                                         AiliaDetectorAlgorithm algorithm,
                                         int categoryCount,
                                         java.util.EnumSet<AiliaDetectorFlags> flags)
                                  throws AiliaException

Creates a detector object.

Parameters:

format - The network image format (AiliaNetworkImageFormat)

channel - The network image channel (AiliaNetworkImageChannel)

range - The network image range (AiliaNetworkImageRange)

algorithm - The network algorithm AiliaDetectorAlgorithm

categoryCount - The number of detection categories (specify 20 for VOC or 80 for COCO, etc.)

flags - Additional flags AiliaDetectorFlags

Returns:

The instance of a detector wrapper class.

Throws:

AiliaException - Exception

See Also:

AiliaDetector.Create(long, int, int, int, int, int, int)

createDetector

@Deprecated
public AiliaDetectorModel createDetector(AiliaNetworkImageFormat format,
                                                     AiliaNetworkImageChannel channel,
                                                     AiliaNetworkImageRange range,
                                                     int algorithm,
                                                     int categoryCount,
                                                     int flags)
                                              throws AiliaException

Deprecated. Please use #createDetector(AiliaNetworkImageFormat, AiliaNetworkImageChannel, AiliaNetworkImageRange, AiliaDetectorAlgorithm, int, EnumSet)

Throws:

AiliaException

createFeatureExtractor

public AiliaFeatureExtractorModel createFeatureExtractor(AiliaNetworkImageFormat format,
                                                         AiliaNetworkImageChannel channel,
                                                         AiliaNetworkImageRange range,
                                                         java.lang.String layerName)
                                                  throws AiliaException

Creates a feature extractor object.

Parameters:

format - The network image format (AiliaNetworkImageFormat)

channel - The network image channel (AiliaNetworkImageChannel)

range - The network image range (AiliaNetworkImageRange)

layerName - The name of the layer corresponding to the feature (fc1 for VGG16 and NULL for the last layer)

Returns:

The instance of a feature extractor wrapper class.

Throws:

AiliaException - Exception

See Also:

AiliaFeatureExtractor.Create(long, int, int, int, String)

createPoseEstimator

public AiliaPoseEstimatorModel createPoseEstimator(AiliaPoseEstimatorAlgorithm algorithm)
                                            throws AiliaException

Creates a pose estimator object.

Parameters:

algorithm - AiliaPoseEstimatorAlgorithm

Returns:

The instance of pose estimtor wrapper class.

Throws:

AiliaException - Exception

See Also:

AiliaPoseEstimator.Create(long, int)

createPoseEstimator

@Deprecated
public AiliaPoseEstimatorModel createPoseEstimator(int algorithm)
                                                        throws AiliaException

Deprecated. Psease use createPoseEstimator(AiliaPoseEstimatorAlgorithm)

Throws:

AiliaException

predict

public void predict(float[] dest,
                    int destSize,
                    float[] src,
                    int srcSize)
             throws AiliaException

Performs the inferences and provides the inference result.

Parameters:

dest - The result is stored in the inference result destination buffer as float data in the order of X, Y, Z, and W. The buffer has the same size as the network file outputSize.

destSize - The size of the dest (in byte)

src - The input is stored as float data in the order of the inference data X, Y, Z, and W. The input has the same size as the network file inputSize.

srcSize - The size of the src (in byte)

Throws:

AiliaException - Exception

See Also:

Ailia.Predict(long, float[], int, float[], int)

Predict

@Deprecated
public void Predict(float[] dest,
                                int destSize,
                                float[] src,
                                int srcSize)
                         throws AiliaException

Deprecated. Psease use predict(float[], int, float[], int)

Throws:

AiliaException

setInputShape

public void setInputShape(AiliaShape shape)
                   throws AiliaException

Changes the shape of the input data during inference.

Parameters:

shape - Shape information for the input data

Throws:

AiliaException - Exception

See Also:

Ailia.SetInputShape(long, AiliaShape, int)

setInputShapeND

public void setInputShapeND(int[] shape)
                     throws AiliaException

Changes the shape of the input data during inference.

Parameters:

shape - An array of shape

Throws:

AiliaException - Exception

See Also:

Ailia.SetInputShapeND(long, int[], int)

getInputShape

public AiliaShape getInputShape()
                         throws AiliaException

Gets the shape of the input data during inference.

Returns:

The shape of the input data

Throws:

AiliaException - Exception

See Also:

Ailia.GetInputShape(long, int)

getInputShapeND

public int[] getInputShapeND()
                      throws AiliaException

Gets the shape of the input data during inference.

Returns:

The array of shape

Throws:

AiliaException - Exception

See Also:

Ailia.GetInputDim(long), Ailia.GetInputShapeND(long, int[], int)

setInputBlobShape

public void setInputBlobShape(AiliaShape shape,
                              int blobIndex,
                              int version)
                       throws AiliaException

Change the shape of the blob given by its index

Parameters:

shape - New shape of the blob

blobIndex - Index referencing the blob to reshape

version - Shape version(AiliaShape.version)

Throws:

AiliaException - Exception

See Also:

Ailia.SetInputBlobShape(long, AiliaShape, int, int)

setInputBlobShapeND

public void setInputBlobShapeND(int[] shape,
                                int blobIndex)
                         throws AiliaException

Change the shape of the blob given by its index

Parameters:

shape - The array of the new shape.

blobIndex - Index referencing the blob to reshape

Throws:

AiliaException - Exception

See Also:

Ailia.SetInputBlobShapeND(long, int[], int, int)

getBlobShape

public AiliaShape getBlobShape(int blobIndex)
                        throws AiliaException

Gets the shape of the internal data (blob) during inference.

Parameters:

blobIndex - Index referencing the blob to reshape

Returns:

The shape of the internal data (blob).

Throws:

AiliaException - Exception

See Also:

Ailia.GetBlobShape(long, int, int)

getBlobShapeND

public int[] getBlobShapeND(int blobIndex)
                     throws AiliaException

Gets the shape of the internal data (blob) during inference.

Parameters:

blobIndex - Index referencing the blob to reshape

Returns:

The array of shape

Throws:

AiliaException - Exception

See Also:

Ailia.GetBlobShapeND(long, int[], int, int)

getOutputShape

public AiliaShape getOutputShape()
                          throws AiliaException

Gets the shape of the output data during inference.

Returns:

The shape of the output.

Throws:

AiliaException - Exception

See Also:

Ailia.GetOutputShape(long, int)

getOutputShapeND

public int[] getOutputShapeND()
                       throws AiliaException

Gets the shape of the output data during inference.

Returns:

The array of the shape

Throws:

AiliaException - Exception

See Also:

Ailia.GetOutputShapeND(long, int[], int)

getInputBlobCount

public int getInputBlobCount()
                      throws AiliaException

Get the number of input data blobs.

Returns:

The number of input blobs

Throws:

AiliaException - Exception

See Also:

Ailia.GetInputBlobCount(long)

getBlobIndexByInputIndex

public int getBlobIndexByInputIndex(int inputBlobIndex)
                             throws AiliaException

Get the blob index of the input data.

Parameters:

inputBlobIndex - Index among the input blobs (between 0 and getInputBlobCount()-1)

Returns:

Index of the blob

Throws:

AiliaException - Exception

See Also:

Ailia.GetBlobIndexByInputIndex(long, int)

getOutputBlobCount

public int getOutputBlobCount()
                       throws AiliaException

Get the number of output data blobs.

Returns:

The number of output blobs

Throws:

AiliaException - Exception

See Also:

Ailia.GetOutputBlobCount(long)

getBlobIndexByOutputIndex

public int getBlobIndexByOutputIndex(int outputBlobIndex)
                              throws AiliaException

Get the blob index of the output data blob.

Parameters:

outputBlobIndex - Index among output blobs (between 0 and getOutputBlobCount()-1)

Returns:

Blob index

Throws:

AiliaException - Exception

See Also:

Ailia.GetBlobIndexByOutputIndex(long, int)

close

public void close()

It destroys the network instance.

Specified by:

close in interface java.lang.AutoCloseable

See Also:

Ailia.Destroy(long)

getHandle

public long getHandle()

Gets A network instance handle

Returns:

A network instance handle

copyBlob

public void copyBlob(int dstBlobIndex,
                     int srcBlobIndex,
                     AiliaModel srcNet)
              throws AiliaException

Copy blobs between specified models.

Parameters:

dstBlobIndex - The index of destination blob

srcBlobIndex - The index of source blob

srcNet - The AiliaModel object that contains source blob. If specify null, then use this object as srcNet.

Throws:

AiliaException

update

public void update()
            throws AiliaException

Performs the inferences

Throws:

AiliaException - Exception

setInputBlobData

public void setInputBlobData(float[] src,
                             int srcSize,
                             int idx)
                      throws AiliaException

Set the input blob data.

Parameters:

src - The input is stored as float data in the order of the inference data X, Y, Z, and W. The input has the same size as the network file inputSize.

srcSize - The size of the src (in byte)

idx - The blob idx

Throws:

AiliaException - Exception

getBlobData

public void getBlobData(float[] dest,
                        int destSize,
                        int idx)
                 throws AiliaException

Get the output blob data.

Parameters:

dest - The result is stored in the inference result destination buffer as float data in the order of X, Y, Z, and W. The buffer has the same size as the network file outputSize.

destSize - The size of the dest (in byte)

idx - The blob idx

Throws:

AiliaException - Exception

setProfileMode

public void setProfileMode(AiliaProfileMode profileMode)
                    throws AiliaException

Set the profile mode.

Change the profile mode. If a value other than AiliaProfileMode.PROFILE_DISABLE is specified, the profile data is added to Summary

Parameters:

profileMode - Profile mode (Default :AiliaProfileMode.PROFILE_DISABLE)

Throws:

AiliaException - Exception

getSummary

public java.lang.String getSummary()
                            throws AiliaException

Shows the name and shape of each blob.

Returns:

The summary string

Throws:

AiliaException - Exception