A typed multi-dimensional array used in Tensorflow Lite.
The native handle of a Tensor is managed by NativeInterpreterWrapper, and does
not needed to be closed by the client. However, once the NativeInterpreterWrapper has
been closed, the tensor handle will be invalidated.
Returns a read-only ByteBuffer view of the tensor data.
In general, this method is most useful for obtaining a read-only view of output tensor data,
*after* inference has been executed (e.g., via InterpreterApi.run(Object, Object)). In
particular, some graphs have dynamically shaped outputs, which can make feeding a predefined
output buffer to the interpreter awkward. Example usage:
interpreter.run(input, null);
ByteBuffer outputBuffer = interpreter.getOutputTensor(0).asReadOnlyBuffer();
// Copy or read from outputBuffer.
WARNING: If the tensor has not yet been allocated, e.g., before inference has been executed,
the result is undefined. Note that the underlying tensor pointer may also change when the
tensor is invalidated in any way (e.g., if inference is executed, or the graph is resized), so
it is *not* safe to hold a reference to the returned buffer beyond immediate use directly
following inference. Example *bad* usage:
ByteBuffer outputBuffer = interpreter.getOutputTensor(0).asReadOnlyBuffer();
interpreter.run(input, null);
// Copy or read from outputBuffer (which may now be invalid).
Returns the quantization parameters of the tensor within the owning interpreter.
Only quantized tensors have valid QuantizationParameters. For tensor that are not
quantized, the values of scale and zero_point are both 0.
public
abstract
int[]
shape()
Returns the shape of
the Tensor, i.e., the sizes of each dimension.
Returns
an array where the i-th element is the size of the i-th dimension of the tensor.
public
abstract
int[]
shapeSignature()
Returns the original shape of the Tensor,
i.e., the sizes of each dimension - before any resizing was performed. Unknown dimensions are
designated with a value of -1.
Returns
an array where the i-th element is the size of the i-th dimension of the tensor.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-05-10 UTC."],[],[],null,["# Tensor\n\npublic interface **Tensor** \nA typed multi-dimensional array used in Tensorflow Lite.\n\nThe native handle of a `Tensor` is managed by `NativeInterpreterWrapper`, and does\nnot needed to be closed by the client. However, once the `NativeInterpreterWrapper` has\nbeen closed, the tensor handle will be invalidated.\n\n\u003cbr /\u003e\n\n### Nested Classes\n\n|-------|---|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| class | [Tensor.QuantizationParams](/edge/api/tflite/java/org/tensorflow/lite/Tensor.QuantizationParams) || Quantization parameters that corresponds to the table, `QuantizationParameters`, in the [TFLite Model schema file.](https://github.com/tensorflow/tensorflow/blob/master/tensorflow/lite/schema/schema.fbs) |\n\n### Public Methods\n\n|-----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [ByteBuffer](https://developer.android.com/reference/java/nio/ByteBuffer.html) | [asReadOnlyBuffer](/edge/api/tflite/java/org/tensorflow/lite/Tensor#asReadOnlyBuffer())() Returns a read-only `ByteBuffer` view of the tensor data. |\n| abstract [DataType](/edge/api/tflite/java/org/tensorflow/lite/DataType) | [dataType](/edge/api/tflite/java/org/tensorflow/lite/Tensor#dataType())() Returns the [DataType](/edge/api/tflite/java/org/tensorflow/lite/DataType) of elements stored in the Tensor. |\n| abstract int | [numBytes](/edge/api/tflite/java/org/tensorflow/lite/Tensor#numBytes())() Returns the size, in bytes, of the tensor data. |\n| abstract int | [numDimensions](/edge/api/tflite/java/org/tensorflow/lite/Tensor#numDimensions())() Returns the number of dimensions (sometimes referred to as [rank](https://www.tensorflow.org/resources/dims_types.html#rank)) of the Tensor. |\n| abstract int | [numElements](/edge/api/tflite/java/org/tensorflow/lite/Tensor#numElements())() Returns the number of elements in a flattened (1-D) view of the tensor. |\n| abstract [Tensor.QuantizationParams](/edge/api/tflite/java/org/tensorflow/lite/Tensor.QuantizationParams) | [quantizationParams](/edge/api/tflite/java/org/tensorflow/lite/Tensor#quantizationParams())() Returns the quantization parameters of the tensor within the owning interpreter. |\n| abstract int\\[\\] | [shape](/edge/api/tflite/java/org/tensorflow/lite/Tensor#shape())() Returns the [shape](https://www.tensorflow.org/resources/dims_types.html#shape) of the Tensor, i.e., the sizes of each dimension. |\n| abstract int\\[\\] | [shapeSignature](/edge/api/tflite/java/org/tensorflow/lite/Tensor#shapeSignature())() Returns the original [shape](https://www.tensorflow.org/resources/dims_types.html#shape) of the Tensor, i.e., the sizes of each dimension - before any resizing was performed. |\n\nPublic Methods\n--------------\n\n#### public abstract [ByteBuffer](https://developer.android.com/reference/java/nio/ByteBuffer.html)\n**asReadOnlyBuffer**\n()\n\nReturns a read-only `ByteBuffer` view of the tensor data.\n\nIn general, this method is most useful for obtaining a read-only view of output tensor data,\n\\*after\\* inference has been executed (e.g., via [InterpreterApi.run(Object, Object)](/edge/api/tflite/java/org/tensorflow/lite/InterpreterApi#run(java.lang.Object,%20java.lang.Object))). In\nparticular, some graphs have dynamically shaped outputs, which can make feeding a predefined\noutput buffer to the interpreter awkward. Example usage:\n\n interpreter.run(input, null);\n ByteBuffer outputBuffer = interpreter.getOutputTensor(0).asReadOnlyBuffer();\n // Copy or read from outputBuffer.\n\nWARNING: If the tensor has not yet been allocated, e.g., before inference has been executed,\nthe result is undefined. Note that the underlying tensor pointer may also change when the\ntensor is invalidated in any way (e.g., if inference is executed, or the graph is resized), so\nit is \\*not\\* safe to hold a reference to the returned buffer beyond immediate use directly\nfollowing inference. Example \\*bad\\* usage:\n\n ByteBuffer outputBuffer = interpreter.getOutputTensor(0).asReadOnlyBuffer();\n interpreter.run(input, null);\n // Copy or read from outputBuffer (which may now be invalid).\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n##### Throws\n\n| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException.html) | if the tensor data has not been allocated. |\n|-------------------------------------------------------------------------------------------------------------|--------------------------------------------|\n\n#### public abstract [DataType](/edge/api/tflite/java/org/tensorflow/lite/DataType)\n**dataType**\n()\n\nReturns the [DataType](/edge/api/tflite/java/org/tensorflow/lite/DataType) of elements stored in the Tensor. \n\n#### public abstract int\n**numBytes**\n()\n\nReturns the size, in bytes, of the tensor data. \n\n#### public abstract int\n**numDimensions**\n()\n\nReturns the number of dimensions (sometimes referred to as [rank](https://www.tensorflow.org/resources/dims_types.html#rank)) of the Tensor.\n\nWill be 0 for a scalar, 1 for a vector, 2 for a matrix, 3 for a 3-dimensional tensor etc.\n\n\u003cbr /\u003e\n\n#### public abstract int\n**numElements**\n()\n\nReturns the number of elements in a flattened (1-D) view of the tensor. \n\n#### public abstract [Tensor.QuantizationParams](/edge/api/tflite/java/org/tensorflow/lite/Tensor.QuantizationParams)\n**quantizationParams**\n()\n\nReturns the quantization parameters of the tensor within the owning interpreter.\n\nOnly quantized tensors have valid `QuantizationParameters`. For tensor that are not\nquantized, the values of scale and zero_point are both 0.\n\n\u003cbr /\u003e\n\n#### public abstract int\\[\\]\n**shape**\n()\n\nReturns the [shape](https://www.tensorflow.org/resources/dims_types.html#shape) of\nthe Tensor, i.e., the sizes of each dimension. \n\n##### Returns\n\n- an array where the i-th element is the size of the i-th dimension of the tensor. \n\n#### public abstract int\\[\\]\n**shapeSignature**\n()\n\nReturns the original [shape](https://www.tensorflow.org/resources/dims_types.html#shape) of the Tensor,\ni.e., the sizes of each dimension - before any resizing was performed. Unknown dimensions are\ndesignated with a value of -1. \n\n##### Returns\n\n- an array where the i-th element is the size of the i-th dimension of the tensor."]]