Package ai.onnxruntime

Enum OrtProvider

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<OrtProvider>
    public enum OrtProvider
extends java.lang.Enum<OrtProvider>
    The execution providers available through the Java API.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ACL
      The ARM Compute Library execution provider.
      ARM_NN
      The ARM NN execution provider.
      AZURE
      The Azure remote endpoint execution provider.
      CORE_ML
      The Apple CoreML execution provider.
      CPU
      The CPU execution provider.
      CUDA
      CUDA execution provider for Nvidia GPUs.
      DIRECT_ML
      The Windows DirectML execution provider.
      DNNL
      The Intel Deep Neural Network Library execution provider.
      MI_GRAPH_X
      The AMD MIGraphX execution provider.
      NNAPI
      The Android NNAPI execution provider.
      OPEN_VINO
      The OpenVINO execution provider.
      QNN
      The QNN execution provider.
      RK_NPU
      The RockChip NPU execution provider.
      ROCM
      The AMD ROCm execution provider.
      TENSOR_RT
      The TensorRT execution provider for Nvidia GPUs.
      VITIS_AI
      The AMD/Xilinx VitisAI execution provider.
      WEBGPU
      The WebGPU execution provider
      XNNPACK
      The XNNPACK execution provider.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getName()
      Accessor for the internal name of this provider.
      static OrtProvider mapFromName​(java.lang.String name)
      Maps from the name string used by ONNX Runtime into the enum.
      static OrtProvider valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static OrtProvider[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • CPU

        public static final OrtProvider CPU
        The CPU execution provider.

      • CUDA

        public static final OrtProvider CUDA
        CUDA execution provider for Nvidia GPUs.

      • DNNL

        public static final OrtProvider DNNL
        The Intel Deep Neural Network Library execution provider.

      • OPEN_VINO

        public static final OrtProvider OPEN_VINO
        The OpenVINO execution provider.

      • VITIS_AI

        public static final OrtProvider VITIS_AI
        The AMD/Xilinx VitisAI execution provider.

      • TENSOR_RT

        public static final OrtProvider TENSOR_RT
        The TensorRT execution provider for Nvidia GPUs.

      • NNAPI

        public static final OrtProvider NNAPI
        The Android NNAPI execution provider.

      • RK_NPU

        public static final OrtProvider RK_NPU
        The RockChip NPU execution provider.

      • DIRECT_ML

        public static final OrtProvider DIRECT_ML
        The Windows DirectML execution provider.

      • MI_GRAPH_X

        public static final OrtProvider MI_GRAPH_X
        The AMD MIGraphX execution provider.

      • ACL

        public static final OrtProvider ACL
        The ARM Compute Library execution provider.

      • ARM_NN

        public static final OrtProvider ARM_NN
        The ARM NN execution provider.

      • ROCM

        public static final OrtProvider ROCM
        The AMD ROCm execution provider.

      • CORE_ML

        public static final OrtProvider CORE_ML
        The Apple CoreML execution provider.

      • XNNPACK

        public static final OrtProvider XNNPACK
        The XNNPACK execution provider.

      • AZURE

        public static final OrtProvider AZURE
        The Azure remote endpoint execution provider.

      • QNN

        public static final OrtProvider QNN
        The QNN execution provider.

      • WEBGPU

        public static final OrtProvider WEBGPU
        The WebGPU execution provider

    • Method Detail

      • values

        public static OrtProvider[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (OrtProvider c : OrtProvider.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static OrtProvider valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getName

        public java.lang.String getName()
        Accessor for the internal name of this provider.
        Returns:
        The internal provider name.

      • mapFromName

        public static OrtProvider mapFromName​(java.lang.String name)
        Maps from the name string used by ONNX Runtime into the enum.
        Parameters:
        name - The provider name string.
        Returns:
        The enum constant.