Use custom FFI, and move the ONNX related classes to same folder and namespace

CodeWithKyrian · CodeWithKyrian · commit 66b7e367de61 · 2024-05-08T03:18:19.000+01:00
diff --git a/composer.json b/composer.json
@@ -14,6 +14,7 @@
   "type": "library",
   "require": {
     "php": "^8.1",
+    "ext-ffi": "*",
     "ankane/onnxruntime": "^0.2.0",
     "guzzlehttp/guzzle": "^7.0",
     "codewithkyrian/jinja-php": "^1.0",
@@ -23,7 +24,7 @@
     "rokka/imagine-vips": "^0.31.0",
     "rindow/rindow-math-matrix": "^2.0",
     "rindow/rindow-matlib-ffi": "^1.0",
-    "rindow/rindow-openblas-ffi": "^1.0"
+    "rindow/rindow-openblas-ffi": "^1.0",
   },
   "require-dev": {
     "pestphp/pest": "^2.31",
diff --git a/examples/image_detection.php b/examples/image_detection.php
@@ -10,7 +10,7 @@
 
 $pixels = getPixels($img);
 
-$model = new OnnxRuntime\Model(__DIR__ . '/models/ssd_mobilenet_v1_10.onnx');
+$model = new Codewithkyrian\Transformers\Utils\Model(__DIR__ . '/models/ssd_mobilenet_v1_10.onnx');
 $result = $model->predict(['image_tensor:0' => [$pixels]]);
 
 foreach ($result['num_detections:0'] as $idx => $n) {
diff --git a/src/Libraries.php b/src/Libraries.php
@@ -22,8 +22,11 @@ enum Libraries
 
     protected const LIBRARIES = [
         'x86_64-darwin' => [
-            'archive' => 'libraries-osx-x86_64-{{version}}.tar.gz',
-            'checksum' => 'f72a2bcca40e2650756c6b96c69ef031236aaab1b98673e744da4eef0c4bddbd',
+            'archive' => [
+                'name' => 'libraries-osx-x86_64-{{version}}',
+                'format' => 'tar.gz',
+                'checksum' => 'f72a2bcca40e2650756c6b96c69ef031236aaab1b98673e744da4eef0c4bddbd',
+            ],
             'rindowmatlib.serial' => [
                 'folder' => 'rindow-matlib-Darwin-{{version}}',
                 'lib' => 'librindowmatlib_serial.dylib',
@@ -62,8 +65,11 @@ enum Libraries
         ],
 
         'arm64-darwin' => [
-            'archive' => 'libraries-osx-arm64-{{version}}.tar.gz',
-            'checksum' => 'f72a2bcca40e2650756c6b96c69ef031236aaab1b98673e744da4eef0c4bddbd',
+            'archive' => [
+                'name' => 'libraries-osx-arm64-{{version}}',
+                'format' => 'tar.gz',
+                'checksum' => 'f72a2bcca40e2650756c6b96c69ef031236aaab1b98673e744da4eef0c4bddbd',
+            ],
             'rindowmatlib.serial' => [
                 'folder' => 'rindow-matlib-Darwin-{{version}}',
                 'lib' => 'librindowmatlib_serial.dylib',
@@ -102,8 +108,11 @@ enum Libraries
         ],
 
         'x86_64-linux' => [
-            'archive' => 'libraries-linux-x86_64-{{version}}.tar.gz',
-            'checksum' => 'f72a2bcca40e2650756c6b96c69ef031236aaab1b98673e744da4eef0c4bddbd',
+            'archive' => [
+                'name' => 'libraries-linux-x86_64-{{version}}',
+                'format' => 'tar.gz',
+                'checksum' => 'f72a2bcca40e2650756c6b96c69ef031236aaab1b98673e744da4eef0c4bddbd',
+            ],
             'rindowmatlib.serial' => [
                 'folder' => 'rindow-matlib-Linux-{{version}}',
                 'lib' => 'librindowmatlib_serial.so',
@@ -142,8 +151,11 @@ enum Libraries
         ],
 
         'aarch64-linux' => [
-            'archive' => 'libraries-linux-arm64-{{version}}.tar.gz',
-            'checksum' => 'f72a2bcca40e2650756c6b96c69ef031236aaab1b98673e744da4eef0c4bddbd',
+            'archive' => [
+                'name' => 'libraries-linux-arm64-{{version}}',
+                'format' => 'tar.gz',
+                'checksum' => 'f72a2bcca40e2650756c6b96c69ef031236aaab1b98673e744da4eef0c4bddbd',
+            ],
             'rindowmatlib.serial' => [
                 'folder' => 'rindow-matlib-Linux-{{version}}',
                 'lib' => 'librindowmatlib_serial.so',
@@ -182,8 +194,11 @@ enum Libraries
         ],
 
         'x64-windows' => [
-            'archive' => 'libraries-windows-x64-{{version}}.zip',
-            'checksum' => 'f72a2bcca40e2650756c6b96c69ef031236aaab1b98673e744da4eef0c4bddbd',
+            'archive' => [
+                'name' => 'libraries-windows-x64-{{version}}',
+                'format' => 'zip',
+                'checksum' => 'f72a2bcca40e2650756c6b96c69ef031236aaab1b98673e744da4eef0c4bddbd',
+            ],
             'rindowmatlib.serial' => [
                 'folder' => 'rindow-matlib-Windows-{{version}}',
                 'lib' => 'rindowmatlib_serial.dll',
diff --git a/src/Models/Pretrained/BartForConditionalGeneration.php b/src/Models/Pretrained/BartForConditionalGeneration.php
@@ -6,9 +6,9 @@
 namespace Codewithkyrian\Transformers\Models\Pretrained;
 
 use Codewithkyrian\Transformers\Models\ModelArchitecture;
+use Codewithkyrian\Transformers\OnnxRuntime\InferenceSession;
 use Codewithkyrian\Transformers\Utils\AutoConfig;
 use Codewithkyrian\Transformers\Utils\GenerationConfig;
-use Codewithkyrian\Transformers\Utils\InferenceSession;
 
 /**
  * The BART Model with a language modeling head. Can be used for summarization.
diff --git a/src/Models/Pretrained/CodeGenPretrainedModel.php b/src/Models/Pretrained/CodeGenPretrainedModel.php
@@ -6,8 +6,8 @@
 namespace Codewithkyrian\Transformers\Models\Pretrained;
 
 use Codewithkyrian\Transformers\Models\ModelArchitecture;
+use Codewithkyrian\Transformers\OnnxRuntime\InferenceSession;
 use Codewithkyrian\Transformers\Utils\AutoConfig;
-use Codewithkyrian\Transformers\Utils\InferenceSession;
 
 class CodeGenPretrainedModel extends PretrainedModel
 {
diff --git a/src/Models/Pretrained/GPT2PretrainedModel.php b/src/Models/Pretrained/GPT2PretrainedModel.php
@@ -6,9 +6,9 @@
 namespace Codewithkyrian\Transformers\Models\Pretrained;
 
 use Codewithkyrian\Transformers\Models\ModelArchitecture;
+use Codewithkyrian\Transformers\OnnxRuntime\InferenceSession;
 use Codewithkyrian\Transformers\Utils\AutoConfig;
 use Codewithkyrian\Transformers\Utils\GenerationConfig;
-use Codewithkyrian\Transformers\Utils\InferenceSession;
 
 class GPT2PretrainedModel extends PretrainedModel
 {
diff --git a/src/Models/Pretrained/GPTBigCodePretrainedModel.php b/src/Models/Pretrained/GPTBigCodePretrainedModel.php
@@ -6,9 +6,9 @@
 namespace Codewithkyrian\Transformers\Models\Pretrained;
 
 use Codewithkyrian\Transformers\Models\ModelArchitecture;
+use Codewithkyrian\Transformers\OnnxRuntime\InferenceSession;
 use Codewithkyrian\Transformers\Utils\AutoConfig;
 use Codewithkyrian\Transformers\Utils\GenerationConfig;
-use Codewithkyrian\Transformers\Utils\InferenceSession;
 
 class GPTBigCodePretrainedModel extends PretrainedModel
 {
diff --git a/src/Models/Pretrained/GPTJPretrainedModel.php b/src/Models/Pretrained/GPTJPretrainedModel.php
@@ -6,8 +6,8 @@
 namespace Codewithkyrian\Transformers\Models\Pretrained;
 
 use Codewithkyrian\Transformers\Models\ModelArchitecture;
+use Codewithkyrian\Transformers\OnnxRuntime\InferenceSession;
 use Codewithkyrian\Transformers\Utils\AutoConfig;
-use Codewithkyrian\Transformers\Utils\InferenceSession;
 
 class GPTJPretrainedModel extends PretrainedModel
 {
diff --git a/src/Models/Pretrained/LlamaPretrainedModel.php b/src/Models/Pretrained/LlamaPretrainedModel.php
@@ -6,9 +6,9 @@
 namespace Codewithkyrian\Transformers\Models\Pretrained;
 
 use Codewithkyrian\Transformers\Models\ModelArchitecture;
+use Codewithkyrian\Transformers\OnnxRuntime\InferenceSession;
 use Codewithkyrian\Transformers\Utils\AutoConfig;
 use Codewithkyrian\Transformers\Utils\GenerationConfig;
-use Codewithkyrian\Transformers\Utils\InferenceSession;
 
 
 /**
diff --git a/src/Models/Pretrained/M2M100ForConditionalGeneration.php b/src/Models/Pretrained/M2M100ForConditionalGeneration.php
@@ -6,9 +6,9 @@
 namespace Codewithkyrian\Transformers\Models\Pretrained;
 
 use Codewithkyrian\Transformers\Models\ModelArchitecture;
+use Codewithkyrian\Transformers\OnnxRuntime\InferenceSession;
 use Codewithkyrian\Transformers\Utils\AutoConfig;
 use Codewithkyrian\Transformers\Utils\GenerationConfig;
-use Codewithkyrian\Transformers\Utils\InferenceSession;
 
 class M2M100ForConditionalGeneration extends M2M100PretrainedModel
 {
diff --git a/src/Models/Pretrained/PretrainedModel.php b/src/Models/Pretrained/PretrainedModel.php
@@ -24,10 +24,10 @@
 use Codewithkyrian\Transformers\Models\Auto\AutoModelForSeq2SeqLM;
 use Codewithkyrian\Transformers\Models\ModelArchitecture;
 use Codewithkyrian\Transformers\Models\Output\ModelOutput;
+use Codewithkyrian\Transformers\OnnxRuntime\InferenceSession;
 use Codewithkyrian\Transformers\Utils\AutoConfig;
 use Codewithkyrian\Transformers\Utils\GenerationConfig;
 use Codewithkyrian\Transformers\Utils\Hub;
-use Codewithkyrian\Transformers\Utils\InferenceSession;
 use Codewithkyrian\Transformers\Utils\Tensor;
 use Error;
 use Exception;
diff --git a/src/Models/Pretrained/Qwen2PreTrainedModel.php b/src/Models/Pretrained/Qwen2PreTrainedModel.php
@@ -6,9 +6,9 @@
 namespace Codewithkyrian\Transformers\Models\Pretrained;
 
 use Codewithkyrian\Transformers\Models\ModelArchitecture;
+use Codewithkyrian\Transformers\OnnxRuntime\InferenceSession;
 use Codewithkyrian\Transformers\Utils\AutoConfig;
 use Codewithkyrian\Transformers\Utils\GenerationConfig;
-use Codewithkyrian\Transformers\Utils\InferenceSession;
 
 /**
  * The bare Qwen2 Model outputting raw hidden-states without any specific head on top.
diff --git a/src/Models/Pretrained/T5ForConditionalGeneration.php b/src/Models/Pretrained/T5ForConditionalGeneration.php
@@ -6,9 +6,9 @@
 namespace Codewithkyrian\Transformers\Models\Pretrained;
 
 use Codewithkyrian\Transformers\Models\ModelArchitecture;
+use Codewithkyrian\Transformers\OnnxRuntime\InferenceSession;
 use Codewithkyrian\Transformers\Utils\AutoConfig;
 use Codewithkyrian\Transformers\Utils\GenerationConfig;
-use Codewithkyrian\Transformers\Utils\InferenceSession;
 
 /**
  * T5Model is a class representing a T5 model for conditional generation.
diff --git a/src/Models/Pretrained/TrOCRPretrainedModel.php b/src/Models/Pretrained/TrOCRPretrainedModel.php
@@ -6,9 +6,9 @@
 namespace Codewithkyrian\Transformers\Models\Pretrained;
 
 use Codewithkyrian\Transformers\Models\ModelArchitecture;
+use Codewithkyrian\Transformers\OnnxRuntime\InferenceSession;
 use Codewithkyrian\Transformers\Utils\AutoConfig;
 use Codewithkyrian\Transformers\Utils\GenerationConfig;
-use Codewithkyrian\Transformers\Utils\InferenceSession;
 
 class TrOCRPretrainedModel extends PretrainedModel
 {
diff --git a/src/Models/Pretrained/VisionEncoderDecoderModel.php b/src/Models/Pretrained/VisionEncoderDecoderModel.php
@@ -9,9 +9,9 @@
 use Codewithkyrian\Transformers\Models\Auto\AutoModel;
 use Codewithkyrian\Transformers\Models\Auto\AutoModelForCausalLM;
 use Codewithkyrian\Transformers\Models\ModelArchitecture;
+use Codewithkyrian\Transformers\OnnxRuntime\InferenceSession;
 use Codewithkyrian\Transformers\Utils\AutoConfig;
 use Codewithkyrian\Transformers\Utils\GenerationConfig;
-use Codewithkyrian\Transformers\Utils\InferenceSession;
 
 /**
  * Vision Encoder-Decoder model based on OpenAI's GPT architecture for image captioning and other vision tasks
diff --git a/src/OnnxRuntime/ExecutionMode.php b/src/OnnxRuntime/ExecutionMode.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codewithkyrian\Transformers\OnnxRuntime;
+
+enum ExecutionMode: int
+{
+    case Sequential = 0;
+    case Parallel = 1;
+}
diff --git a/src/OnnxRuntime/FFI.php b/src/OnnxRuntime/FFI.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace Codewithkyrian\Transformers\OnnxRuntime;
+
+use Codewithkyrian\Transformers\Libraries;
+
+class FFI
+{
+    public static mixed $lib;
+    private static \FFI $instance;
+
+    public static function instance(): \FFI
+    {
+        if (!isset(self::$instance)) {
+            $headerCode = file_get_contents(Libraries::OnnxRuntime->headerFile());
+            self::$instance = \FFI::cdef($headerCode, Libraries::OnnxRuntime->libFile());
+        }
+
+        return self::$instance;
+    }
+
+    public static function libVersion(): string
+    {
+        return (self::instance()->OrtGetApiBase()[0]->GetVersionString)();
+    }
+
+    private static \FFI $libc;
+
+    // for Windows
+    public static function libc(): \FFI
+    {
+        if (!isset(self::$libc)) {
+            self::$libc = \FFI::cdef(
+                'size_t mbstowcs(void *wcstr, const char *mbstr, size_t count);',
+                'msvcrt.dll'
+            );
+        }
+
+        return self::$libc;
+    }
+}
diff --git a/src/OnnxRuntime/GraphOptimizationLevel.php b/src/OnnxRuntime/GraphOptimizationLevel.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codewithkyrian\Transformers\OnnxRuntime;
+
+enum GraphOptimizationLevel: int
+{
+    case None = 0;
+    case Basic = 1;
+    case Extended = 2;
+    case All = 99;
+}
diff --git a/src/OnnxRuntime/InferenceSession.php b/src/OnnxRuntime/InferenceSession.php
@@ -1,19 +1,17 @@
 <?php
 
-declare(strict_types=1);
+namespace Codewithkyrian\Transformers\OnnxRuntime;
 
-
-namespace Codewithkyrian\Transformers\Utils;
-
-use OnnxRuntime\Exception;
-use OnnxRuntime\FFI;
+use Exception;
+use Codewithkyrian\Transformers\Utils\Tensor;
+use FFI\CData;
 
 class InferenceSession
 {
-    private $ffi;
+    private \FFI $ffi;
     private mixed $api;
-    private $session;
-    private $allocator;
+    private ?CData $session;
+    private ?CData $allocator;
     private array $inputs;
     private array $outputs;
 
diff --git a/src/Transformers.php b/src/Transformers.php
@@ -7,7 +7,7 @@
 
 use Codewithkyrian\Transformers\Utils\Image;
 use Codewithkyrian\Transformers\Utils\ImageDriver;
-use OnnxRuntime\Vendor;
+use Codewithkyrian\Transformers\Utils\Vendor;
 use function Codewithkyrian\Transformers\Utils\joinPaths;
 
 class Transformers

Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,8 @@`
`6`	`6`	`namespace Codewithkyrian\Transformers\Models\Pretrained;`
`7`	`7`
`8`	`8`	`use Codewithkyrian\Transformers\Models\ModelArchitecture;`
	`9`	`+use Codewithkyrian\Transformers\OnnxRuntime\InferenceSession;`
`9`	`10`	`use Codewithkyrian\Transformers\Utils\AutoConfig;`
`10`		`-use Codewithkyrian\Transformers\Utils\InferenceSession;`
`11`	`11`
`12`	`12`	`class CodeGenPretrainedModel extends PretrainedModel`
`13`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,9 +6,9 @@`
`6`	`6`	`namespace Codewithkyrian\Transformers\Models\Pretrained;`
`7`	`7`
`8`	`8`	`use Codewithkyrian\Transformers\Models\ModelArchitecture;`
	`9`	`+use Codewithkyrian\Transformers\OnnxRuntime\InferenceSession;`
`9`	`10`	`use Codewithkyrian\Transformers\Utils\AutoConfig;`
`10`	`11`	`use Codewithkyrian\Transformers\Utils\GenerationConfig;`
`11`		`-use Codewithkyrian\Transformers\Utils\InferenceSession;`
`12`	`12`
`13`	`13`	`class GPT2PretrainedModel extends PretrainedModel`
`14`	`14`	`{`