org.bytedeco.tensorflowlite

Class FlatBufferModelBase

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.tensorflowlite.FlatBufferModelBase

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

FlatBufferModel

@Name(value="tflite::impl::FlatBufferModelBase<tflite::impl::FlatBufferModel>")
 @NoOffset
 @Properties(inherit=tensorflowlite.class)
public class FlatBufferModelBase
extends Pointer

An RAII object that represents a read-only tflite model, copied from disk, or mmapped. This uses flatbuffers as the serialization format. NOTE: The current API requires that a FlatBufferModelBase instance be kept alive by the client as long as it is in use by any dependent Interpreter instances. As the FlatBufferModelBase instance is effectively immutable after creation, the client may safely use a single model with multiple dependent Interpreter instances, even across multiple threads (though note that each Interpreter instance is *not* thread-safe).

  using namespace tflite;
  StderrReporter error_reporter;
  auto model = FlatBufferModelBase::BuildFromFile("interesting_model.tflite",
                                              &error_reporter);
  MyOpResolver resolver;  // You need to subclass OpResolver to provide
                          // implementations.
  InterpreterBuilder builder(*model, resolver);
  std::unique_ptr interpreter;
  if(builder(&interpreter) == kTfLiteOk) {
    .. run model inference with interpreter
  }
  

OpResolver must be defined to provide your kernel implementations to the interpreter. This is environment specific and may consist of just the builtin ops, or some custom operators you defined to extend tflite.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
FlatBufferModelBase(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Pointer	access()
Allocation	allocation()
static FlatBufferModel	BuildFromAllocation(Allocation allocation)
static FlatBufferModel	BuildFromAllocation(Allocation allocation, ErrorReporter error_reporter) Builds a model directly from an allocation.
static FlatBufferModel	BuildFromBuffer(BytePointer caller_owned_buffer, long buffer_size)
static FlatBufferModel	BuildFromBuffer(BytePointer caller_owned_buffer, long buffer_size, ErrorReporter error_reporter) Builds a model based on a pre-loaded flatbuffer.
static FlatBufferModel	BuildFromBuffer(String caller_owned_buffer, long buffer_size)
static FlatBufferModel	BuildFromBuffer(String caller_owned_buffer, long buffer_size, ErrorReporter error_reporter)
static FlatBufferModel	BuildFromFile(BytePointer filename)
static FlatBufferModel	BuildFromFile(BytePointer filename, ErrorReporter error_reporter) Builds a model based on a file.
static FlatBufferModel	BuildFromFile(String filename)
static FlatBufferModel	BuildFromFile(String filename, ErrorReporter error_reporter)
static FlatBufferModel	BuildFromFileDescriptor(int fd)
static FlatBufferModel	BuildFromFileDescriptor(int fd, ErrorReporter error_reporter) Builds a model based on a file descriptor.
static FlatBufferModel	BuildFromModel(Pointer caller_owned_model_spec)
static FlatBufferModel	BuildFromModel(Pointer caller_owned_model_spec, ErrorReporter error_reporter) Builds a model directly from a flatbuffer pointer Caller retains ownership of the buffer and should keep it alive until the returned object is destroyed.
static boolean	CheckBufferOutsideModel(Pointer model) Check If the buffer is stored as part of the Flatbuffer or outside Return false if the buffers are part of the Flatbuffer
boolean	CheckModelIdentifier() Returns true if the model identifier is correct (otherwise false and reports an error).
ErrorReporter	error_reporter()
String	GetMinimumRuntime()
Pointer	GetModel()
boolean	initialized()
StringStringMap	ReadAllMetadata()
static StringStringMap	ReadAllMetadata(Pointer model)
void	ValidateModelBuffers(ErrorReporter error_reporter)
static FlatBufferModel	VerifyAndBuildFromAllocation(Allocation allocation)
static FlatBufferModel	VerifyAndBuildFromAllocation(Allocation allocation, TfLiteVerifier extra_verifier, ErrorReporter error_reporter) Verifies whether the content of the allocation is legit, then builds a model based on the provided allocation.
static FlatBufferModel	VerifyAndBuildFromBuffer(BytePointer caller_owned_buffer, long buffer_size)
static FlatBufferModel	VerifyAndBuildFromBuffer(BytePointer caller_owned_buffer, long buffer_size, TfLiteVerifier extra_verifier, ErrorReporter error_reporter) Verifies whether the content of the buffer is legit, then builds a model based on the pre-loaded flatbuffer.
static FlatBufferModel	VerifyAndBuildFromBuffer(String caller_owned_buffer, long buffer_size)
static FlatBufferModel	VerifyAndBuildFromBuffer(String caller_owned_buffer, long buffer_size, TfLiteVerifier extra_verifier, ErrorReporter error_reporter)
static FlatBufferModel	VerifyAndBuildFromFile(BytePointer filename)
static FlatBufferModel	VerifyAndBuildFromFile(BytePointer filename, TfLiteVerifier extra_verifier, ErrorReporter error_reporter) Verifies whether the content of the file is legit, then builds a model based on the file.
static FlatBufferModel	VerifyAndBuildFromFile(String filename)
static FlatBufferModel	VerifyAndBuildFromFile(String filename, TfLiteVerifier extra_verifier, ErrorReporter error_reporter)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FlatBufferModelBase

public FlatBufferModelBase(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

BuildFromFile

@UniquePtr
public static FlatBufferModel BuildFromFile(@Cast(value="const char*")
                                                       BytePointer filename,
                                                       ErrorReporter error_reporter)

Builds a model based on a file. Caller retains ownership of error_reporter and must ensure its lifetime is longer than the FlatBufferModelBase instance. Returns a nullptr in case of failure.

BuildFromFile

@UniquePtr
public static FlatBufferModel BuildFromFile(@Cast(value="const char*")
                                                       BytePointer filename)

BuildFromFile

@UniquePtr
public static FlatBufferModel BuildFromFile(String filename,
                                                       ErrorReporter error_reporter)

BuildFromFile

@UniquePtr
public static FlatBufferModel BuildFromFile(String filename)

VerifyAndBuildFromFile

@UniquePtr
public static FlatBufferModel VerifyAndBuildFromFile(@Cast(value="const char*")
                                                                BytePointer filename,
                                                                TfLiteVerifier extra_verifier,
                                                                ErrorReporter error_reporter)

Verifies whether the content of the file is legit, then builds a model based on the file. The extra_verifier argument is an additional optional verifier for the file contents. By default, we always check with tflite::VerifyModelBuffer. If extra_verifier is supplied, the file contents is also checked against the extra_verifier after the check against tflite::VerifyModelBuilder. Caller retains ownership of error_reporter and must ensure its lifetime is longer than the FlatBufferModelBase instance. Returns a nullptr in case of failure.

VerifyAndBuildFromFile

@UniquePtr
public static FlatBufferModel VerifyAndBuildFromFile(@Cast(value="const char*")
                                                                BytePointer filename)

VerifyAndBuildFromFile

@UniquePtr
public static FlatBufferModel VerifyAndBuildFromFile(String filename,
                                                                TfLiteVerifier extra_verifier,
                                                                ErrorReporter error_reporter)

VerifyAndBuildFromFile

@UniquePtr
public static FlatBufferModel VerifyAndBuildFromFile(String filename)

BuildFromFileDescriptor

@UniquePtr
public static FlatBufferModel BuildFromFileDescriptor(int fd,
                                                                 ErrorReporter error_reporter)

Builds a model based on a file descriptor. Caller retains ownership of error_reporter and must ensure its lifetime is longer than the FlatBufferModelBase instance. Caller retains ownership of fd and must ensure it is closed after BuildFromFile returns. Returns a nullptr in case of failure.

BuildFromFileDescriptor

@UniquePtr
public static FlatBufferModel BuildFromFileDescriptor(int fd)

BuildFromBuffer

@UniquePtr
public static FlatBufferModel BuildFromBuffer(@Cast(value="const char*")
                                                         BytePointer caller_owned_buffer,
                                                         @Cast(value="size_t")
                                                         long buffer_size,
                                                         ErrorReporter error_reporter)

Builds a model based on a pre-loaded flatbuffer. Caller retains ownership of the buffer and should keep it alive until the returned object is destroyed. Caller also retains ownership of error_reporter and must ensure its lifetime is longer than the FlatBufferModelBase instance. Returns a nullptr in case of failure. NOTE: this does NOT validate the buffer so it should NOT be called on invalid/untrusted input. Use VerifyAndBuildFromBuffer in that case

BuildFromBuffer

@UniquePtr
public static FlatBufferModel BuildFromBuffer(@Cast(value="const char*")
                                                         BytePointer caller_owned_buffer,
                                                         @Cast(value="size_t")
                                                         long buffer_size)

BuildFromBuffer

@UniquePtr
public static FlatBufferModel BuildFromBuffer(String caller_owned_buffer,
                                                         @Cast(value="size_t")
                                                         long buffer_size,
                                                         ErrorReporter error_reporter)

BuildFromBuffer

@UniquePtr
public static FlatBufferModel BuildFromBuffer(String caller_owned_buffer,
                                                         @Cast(value="size_t")
                                                         long buffer_size)

VerifyAndBuildFromBuffer

@UniquePtr
public static FlatBufferModel VerifyAndBuildFromBuffer(@Cast(value="const char*")
                                                                  BytePointer caller_owned_buffer,
                                                                  @Cast(value="size_t")
                                                                  long buffer_size,
                                                                  TfLiteVerifier extra_verifier,
                                                                  ErrorReporter error_reporter)

Verifies whether the content of the buffer is legit, then builds a model based on the pre-loaded flatbuffer. The extra_verifier argument is an additional optional verifier for the buffer. By default, we always check with tflite::VerifyModelBuffer. If extra_verifier is supplied, the buffer is checked against the extra_verifier after the check against tflite::VerifyModelBuilder. The caller retains ownership of the buffer and should keep it alive until the returned object is destroyed. Caller retains ownership of error_reporter and must ensure its lifetime is longer than the FlatBufferModelBase instance. Returns a nullptr in case of failure.

VerifyAndBuildFromBuffer

@UniquePtr
public static FlatBufferModel VerifyAndBuildFromBuffer(@Cast(value="const char*")
                                                                  BytePointer caller_owned_buffer,
                                                                  @Cast(value="size_t")
                                                                  long buffer_size)

VerifyAndBuildFromBuffer

@UniquePtr
public static FlatBufferModel VerifyAndBuildFromBuffer(String caller_owned_buffer,
                                                                  @Cast(value="size_t")
                                                                  long buffer_size,
                                                                  TfLiteVerifier extra_verifier,
                                                                  ErrorReporter error_reporter)

VerifyAndBuildFromBuffer

@UniquePtr
public static FlatBufferModel VerifyAndBuildFromBuffer(String caller_owned_buffer,
                                                                  @Cast(value="size_t")
                                                                  long buffer_size)

BuildFromAllocation

@UniquePtr
public static FlatBufferModel BuildFromAllocation(@UniquePtr
                                                             Allocation allocation,
                                                             ErrorReporter error_reporter)

Builds a model directly from an allocation. Ownership of the allocation is passed to the model, but the caller retains ownership of error_reporter and must ensure its lifetime is longer than the FlatBufferModelBase instance. Returns a nullptr in case of failure (e.g., the allocation is invalid).

BuildFromAllocation

@UniquePtr
public static FlatBufferModel BuildFromAllocation(@UniquePtr
                                                             Allocation allocation)

VerifyAndBuildFromAllocation

@UniquePtr
public static FlatBufferModel VerifyAndBuildFromAllocation(@UniquePtr
                                                                      Allocation allocation,
                                                                      TfLiteVerifier extra_verifier,
                                                                      ErrorReporter error_reporter)

Verifies whether the content of the allocation is legit, then builds a model based on the provided allocation. The extra_verifier argument is an additional optional verifier for the buffer. By default, we always check with tflite::VerifyModelBuffer. If extra_verifier is supplied, the buffer is checked against the extra_verifier after the check against tflite::VerifyModelBuilder. Ownership of the allocation is passed to the model, but the caller retains ownership of error_reporter and must ensure its lifetime is longer than the FlatBufferModelBase instance. Returns a nullptr in case of failure.

VerifyAndBuildFromAllocation

@UniquePtr
public static FlatBufferModel VerifyAndBuildFromAllocation(@UniquePtr
                                                                      Allocation allocation)

BuildFromModel

@UniquePtr
public static FlatBufferModel BuildFromModel(@Cast(value="const tflite::Model*")
                                                        Pointer caller_owned_model_spec,
                                                        ErrorReporter error_reporter)

Builds a model directly from a flatbuffer pointer Caller retains ownership of the buffer and should keep it alive until the returned object is destroyed. Caller retains ownership of error_reporter and must ensure its lifetime is longer than the FlatBufferModelBase instance. Returns a nullptr in case of failure.

BuildFromModel

@UniquePtr
public static FlatBufferModel BuildFromModel(@Cast(value="const tflite::Model*")
                                                        Pointer caller_owned_model_spec)

initialized

@Cast(value="bool")
public boolean initialized()

access

@Cast(value="const tflite::Model*")
 @Name(value="operator ->")
public Pointer access()

GetModel

@Cast(value="const tflite::Model*")
public Pointer GetModel()

error_reporter

public ErrorReporter error_reporter()

allocation

@Const
public Allocation allocation()

GetMinimumRuntime

@StdString
public String GetMinimumRuntime()

ReadAllMetadata

@ByVal
public StringStringMap ReadAllMetadata()

ReadAllMetadata

@ByVal
public static StringStringMap ReadAllMetadata(@Cast(value="const tflite::Model*")
                                                     Pointer model)

ValidateModelBuffers

public void ValidateModelBuffers(ErrorReporter error_reporter)

CheckModelIdentifier

@Cast(value="bool")
public boolean CheckModelIdentifier()

Returns true if the model identifier is correct (otherwise false and reports an error).

CheckBufferOutsideModel

@Cast(value="bool")
public static boolean CheckBufferOutsideModel(@Cast(value="const tflite::Model*")
                                                                  Pointer model)

Check If the buffer is stored as part of the Flatbuffer or outside Return false if the buffers are part of the Flatbuffer