View Source TFLiteElixir.Coral (tflite_elixir v0.3.7)

This module contains libcoral C++ API, which provides convenient functions to perform inferencing and on-device transfer learning with TensorFlow Lite models on Coral devices.

Summary

Functions

Checks whether a tflite model contains any Edge TPU custom operator.

Returns a dequantized version of the given tensor.

Returns a list of connected edge TPU devices.

Returns TPU context or an error-tuple if requested TPU context is not available.

Creates a new interpreter instance for an Edge TPU model.

Functions

Link to this function

contains_edge_tpu_custom_op?(flat_buffer_model)

View Source
@spec contains_edge_tpu_custom_op?(%TFLiteElixir.FlatBufferModel{
  initialized: term(),
  minimum_runtime: term(),
  model: term()
}) :: boolean() | {:error, String.t()}

Checks whether a tflite model contains any Edge TPU custom operator.

Link to this function

dequantize_tensor(interpreter, tensor_index, as_type \\ nil)

View Source
@spec dequantize_tensor(reference(), non_neg_integer(), term()) ::
  [number()] | {:error, String.t()}

Returns a dequantized version of the given tensor.

@spec edge_tpu_devices() :: [String.t()] | {:error, String.t()}

Returns a list of connected edge TPU devices.

Link to this function

get_edge_tpu_context(opts \\ [])

View Source
@spec get_edge_tpu_context(Keyword.t()) :: {:ok, reference()} | {:error, String.t()}

Returns TPU context or an error-tuple if requested TPU context is not available.

Keyword Parameters

  • device: String.t(). Possible values are

    • "" -- any TPU device
    • "usb" -- any TPU device on USB bus
    • "pci" -- any TPU device on PCIe bus
    • ":N" -- N-th TPU device, e.g. ":0"
    • "usb:N" -- N-th TPU device on USB bus, e.g. "usb:0"
    • "pci:N" -- N-th TPU device on PCIe bus, e.g. "pci:0"

    Default value is "".

    Consider 2 USB devices and 4 PCIe devices connected to the host. The way to reference specifically USB devices:

    "usb:0", "usb:1".

    The way to reference specifically PCIe devices:

    "pci:0", "pci:1", "pci:2", "pci:3".

    The generic way to reference all devices (no assumption about device type):

    ":0", ":1", ":2", ":3", ":4", ":5".

  • options: Map. Possible key-value pairs are

    • "Performance": String.t()

      • "Low"
      • "Medium"
      • "High"
      • "Max"

      Default is "Max".

      Adjust internal clock rate to achieve different performance / power balance.

    • "Usb.AlwaysDfu": boolean

      • true
      • false

      Default is false.

      Always perform device firmware update after reset. DFU is usually only necessary after power cycle.

    • "Usb.MaxBulkInQueueLength": String.t()

      • ["0",.., "255"] (Default is "32")

      Larger queue length may improve USB performance on the direction from device to host.

      All TPUs are always enumerated in the same order assuming hardware configuration doesn't change (no added/removed devices between enumerations). Under the assumption above, the same index N will always point to the same device.

Link to this function

get_edge_tpu_context!(opts)

View Source

Raising version of get_edge_tpu_context/1.

Link to this function

make_edge_tpu_interpreter(flat_buffer_model, edgetpu_context)

View Source
@spec make_edge_tpu_interpreter(
  %TFLiteElixir.FlatBufferModel{
    initialized: term(),
    minimum_runtime: term(),
    model: term()
  },
  reference()
) :: {:ok, reference()} | {:error, String.t()}

Creates a new interpreter instance for an Edge TPU model.

Also consider using make_edge_tpu_interpreter!().

Positional Parameters
  • model: FlatBufferModel. The tflite model.

  • edgetpu_context: reference().

    The Edge TPU context, from TFLiteElixir.Coral::get_edge_tpu_context.

    If left nil, the given interpreter will not resolve an Edge TPU delegate. PoseNet custom op is always supported.

Keyword Parameters (todo)
  • resolver: May be nil to use a default resolver.
  • error_reporter: May be nil to use default error reporter, but beware that if null, tflite runtime error messages will not return.
  • interpreter: The pointer to receive the new interpreter.
Link to this function

make_edge_tpu_interpreter!(model, edgetpu_context)

View Source

Raising version of make_edge_tpu_interpreter/2.