Paket ai.onnxruntime

Klasse OrtEnvironment

  • Alle implementierten Schnittstellen
    java.lang.AutoCloseable
    public final class OrtEnvironment
extends java.lang.Object
implements java.lang.AutoCloseable
    Das Host-Objekt für das ONNX Runtime-System. Kann OrtSessions erstellen, die spezifische Modelle kapseln. Dieses Objekt sollte instanziiert werden, bevor andere ONNX Runtime-Klassen erstellt werden.

    Es kann höchstens ein OrtEnvironment-Objekt in der Lebensdauer einer JVM erstellt werden. Diese Klasse implementiert AutoCloseable wie zuvor zur Rückwärtskompatibilität mit 1.10 und früheren Versionen, aber die close-Methode ist eine No-Op. Die Umgebung wird durch einen beim Konstruieren registrierten JVM-Shutdown-Hook geschlossen.

    • Detail der Felder

      • DEFAULT_NAME

        public static final java.lang.String DEFAULT_NAME
        Der Standardname für ORT-Umgebungen, die aus Java konstruiert werden.
        Siehe auch
        Konstante Feldwerte

    • Detail der Methoden

      • getEnvironment

        public static OrtEnvironment getEnvironment​(java.lang.String name)
        Ruft die OrtEnvironment ab. Wenn derzeit keine Umgebung erstellt wurde, wird eine mit dem angegebenen Namen und OrtLoggingLevel.ORT_LOGGING_LEVEL_WARNING erstellt.

        Wenn die Umgebung bereits existiert, wird die vorhandene zurückgegeben und eine Warnung ausgegeben, wenn der Name oder die Protokollstufe von der angeforderten abweicht.

        Parameter
        name - Die Protokoll-ID der Umgebung.
        Rückgabe
        Das OrtEnvironment-Singleton.

      • getEnvironment

        public static OrtEnvironment getEnvironment​(OrtLoggingLevel logLevel)
        Ruft die OrtEnvironment ab. Wenn derzeit keine Umgebung erstellt wurde, wird eine mit DEFAULT_NAME und der angegebenen Protokollstufe erstellt.

        Wenn die Umgebung bereits existiert, wird die vorhandene zurückgegeben und eine Warnung ausgegeben, wenn der Name oder die Protokollstufe von der angeforderten abweicht.

        Parameter
        logLevel - Die zu verwendende Protokollstufe.
        Rückgabe
        Das OrtEnvironment-Singleton.

      • getEnvironment

        public static OrtEnvironment getEnvironment​(OrtLoggingLevel loggingLevel,
                                            java.lang.String name)
        Ruft die OrtEnvironment ab. Wenn derzeit keine Umgebung erstellt wurde, wird eine mit dem angegebenen Namen und der angegebenen Protokollstufe erstellt. Wenn eine Umgebung mit einem anderen Namen bereits existiert, wird diese Umgebung zurückgegeben und eine Warnung ausgegeben.
        Parameter
        loggingLevel - Die zu verwendende Protokollstufe.
        name - Die Protokoll-ID.
        Rückgabe
        Das OrtEnvironment-Singleton.

      • getEnvironment

        public static OrtEnvironment getEnvironment​(OrtLoggingLevel loggingLevel,
                                            java.lang.String name,
                                            OrtEnvironment.ThreadingOptions threadOptions)
        Erstellt eine OrtEnvironment mit den angegebenen globalen Thread-Pool-Optionen. Beachten Sie, dass im Gegensatz zu den anderen getEnvironment-Methoden, wenn eine OrtEnvironment bereits existiert, dieser Aufruf eine IllegalStateException auslöst, da nicht garantiert werden kann, dass die Umgebung die geeignete Thread-Pool-Konfiguration hat.
        Parameter
        loggingLevel - Die zu verwendende Protokollstufe.
        name - Die Protokoll-ID.
        threadOptions - Die globalen Thread-Pool-Optionen.
        Rückgabe
        Das OrtEnvironment-Singleton.

      • createSession

        public OrtSession createSession​(java.lang.String modelPath)
                         throws OrtException
        Erstellt eine Sitzung mit den Standard-OrtSession.SessionOptions, dem Modell und dem Standard-Speicherzuweiser.
        Parameter
        modelPath - Pfad zur Festplatte, von der das Modell geladen werden soll.
        Rückgabe
        Eine OrtSession mit dem angegebenen Modell.
        Wirft
        OrtException - Wenn das Modell nicht geladen werden konnte, nicht kompatibel war oder einen Fehler verursacht hat.

      • createSession

        public OrtSession createSession​(java.lang.String modelPath,
                                OrtSession.SessionOptions options)
                         throws OrtException
        Erstellt eine Sitzung mit den angegebenen OrtSession.SessionOptions, dem Modell und dem Standard-Speicherzuweiser.
        Parameter
        modelPath - Pfad zur Festplatte, von der das Modell geladen werden soll.
        options - Die Sitzungsoptionen.
        Rückgabe
        Eine OrtSession mit dem angegebenen Modell.
        Wirft
        OrtException - Wenn das Modell nicht geladen werden konnte, nicht kompatibel war oder einen Fehler verursacht hat.

      • createSession

        public OrtSession createSession​(java.nio.ByteBuffer modelBuffer,
                                OrtSession.SessionOptions options)
                         throws OrtException
        Erstellt eine Sitzung mit den angegebenen OrtSession.SessionOptions, dem Modell und dem Standard-Speicherzuweiser.
        Parameter
        modelBuffer - Byte-Puffer, der ein ONNX-Modell darstellt. Muss ein direkter Byte-Puffer sein.
        options - Die Sitzungsoptionen.
        Rückgabe
        Eine OrtSession mit dem angegebenen Modell.
        Wirft
        OrtException - Wenn das Modell nicht analysiert werden konnte, nicht kompatibel war oder einen Fehler verursacht hat.

      • createSession

        public OrtSession createSession​(java.nio.ByteBuffer modelBuffer)
                         throws OrtException
        Erstellt eine Sitzung mit den Standard-OrtSession.SessionOptions, dem Modell und dem Standard-Speicherzuweiser.
        Parameter
        modelBuffer - Byte-Puffer, der ein ONNX-Modell darstellt. Muss ein direkter Byte-Puffer sein.
        Rückgabe
        Eine OrtSession mit dem angegebenen Modell.
        Wirft
        OrtException - Wenn das Modell nicht analysiert werden konnte, nicht kompatibel war oder einen Fehler verursacht hat.

      • createSession

        public OrtSession createSession​(byte[] modelArray,
                                OrtSession.SessionOptions options)
                         throws OrtException
        Erstellt eine Sitzung mit den angegebenen OrtSession.SessionOptions, dem Modell und dem Standard-Speicherzuweiser.
        Parameter
        modelArray - Byte-Array, das ein ONNX-Modell darstellt.
        options - Die Sitzungsoptionen.
        Rückgabe
        Eine OrtSession mit dem angegebenen Modell.
        Wirft
        OrtException - Wenn das Modell nicht analysiert werden konnte, nicht kompatibel war oder einen Fehler verursacht hat.

      • createSession

        public OrtSession createSession​(byte[] modelArray)
                         throws OrtException
        Erstellt eine Sitzung mit den Standard-OrtSession.SessionOptions, dem Modell und dem Standard-Speicherzuweiser.
        Parameter
        modelArray - Byte-Array, das ein ONNX-Modell darstellt.
        Rückgabe
        Eine OrtSession mit dem angegebenen Modell.
        Wirft
        OrtException - Wenn das Modell nicht analysiert werden konnte, nicht kompatibel war oder einen Fehler verursacht hat.

      • createTrainingSession

        public OrtTrainingSession createTrainingSession​(java.lang.String checkpointPath,
                                                java.lang.String trainPath,
                                                java.lang.String evalPath,
                                                java.lang.String optimizerPath)
                                         throws OrtException
        Erstellt eine Trainingssitzung mit den Standard-OrtSession.SessionOptions, dem Modell und dem Standard-Speicherzuweiser.
        Parameter
        checkpointPath - Pfad zum Checkpoint-Ordner.
        trainPath - Pfad zum Trainingsmodell.
        evalPath - Pfad zum Evaluationsmodell. Null bedeutet, dass kein Evaluationsmodell vorhanden ist.
        optimizerPath - Pfad zum Optimierermodell. Null bedeutet, dass kein Optimierermodell vorhanden ist.
        Rückgabe
        Eine OrtTrainingSession mit dem angegebenen geladenen Modell.
        Wirft
        OrtException - Wenn das Modell nicht geladen werden konnte, nicht kompatibel war oder einen Fehler verursacht hat.

      • createTrainingSession

        public OrtTrainingSession createTrainingSession​(java.lang.String checkpointPath,
                                                java.lang.String trainPath,
                                                java.lang.String evalPath,
                                                java.lang.String optimizerPath,
                                                OrtSession.SessionOptions options)
                                         throws OrtException
        Erstellt eine Trainingssitzung mit den angegebenen OrtSession.SessionOptions, dem Modell und dem Standard-Speicherzuweiser.
        Parameter
        checkpointPath - Pfad zum Checkpoint-Ordner.
        trainPath - Pfad zum Trainingsmodell.
        evalPath - Pfad zum Evaluationsmodell. Null bedeutet, dass kein Evaluationsmodell vorhanden ist.
        optimizerPath - Pfad zum Optimierermodell. Null bedeutet, dass kein Optimierermodell vorhanden ist.
        options - Die Sitzungsoptionen.
        Rückgabe
        Eine OrtTrainingSession mit dem angegebenen Modell.
        Wirft
        OrtException - Wenn das Modell nicht geladen werden konnte, nicht kompatibel war oder einen Fehler verursacht hat.

      • isTrainingEnabled

        public boolean isTrainingEnabled()
        Ist Training in dieser Build von ONNX Runtime aktiviert?
        Rückgabe
        True, wenn Training aktiviert ist.

      • setTelemetry

        public void setTelemetry​(boolean sendTelemetry)
                  throws OrtException
        Schaltet die Telemetrie ein oder aus.
        Parameter
        sendTelemetry - Wenn true, dann wird Telemetrie zur ONNX Runtime-Nutzung gesendet.
        Wirft
        OrtException - Wenn der Aufruf fehlgeschlagen ist.

      • getVersion

        public java.lang.String getVersion()
        Ruft die Versionszeichenkette der nativen Bibliothek ab.
        Rückgabe
        Die Versionszeichenkette.

      • toString

        public java.lang.String toString()
        Überschreibt
        toString in Klasse java.lang.Object

      • getAvailableProviders

        public static java.util.EnumSet<OrtProvider> getAvailableProviders()
        Ruft die in dieser Umgebung verfügbaren Provider ab.
        Rückgabe
        Eine EnumSet der verfügbaren Ausführungs-Provider.

      • close

        public void close()
        Close ist eine No-Op für OrtEnvironment seit ORT 1.11.
        Spezifiziert von
        close in Schnittstelle java.lang.AutoCloseable