feat: Better error handling for absence of shared libraries

Author: CodeWithKyrian

composer.json

@@ -16,7 +16,7 @@
     "php": "^8.1",
     "ext-ffi": "*",
     "codewithkyrian/jinja-php": "^1.0",
-    "codewithkyrian/transformers-libsloader": "^1.0",
+    "codewithkyrian/transformers-libsloader": "^2.0",
     "imagine/imagine": "^1.3",
     "rokka/imagine-vips": "^0.31.0",
     "rindow/rindow-math-matrix": "^2.0",

examples/images/multitask.png

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Codewithkyrian\Transformers\Pipelines;
+
+use Codewithkyrian\Transformers\Models\Auto\AutoModel;
+use Codewithkyrian\Transformers\Processors\AutoProcessor;
+use Codewithkyrian\Transformers\Utils\Image;
+
+require_once './bootstrap.php';
+
+ini_set('memory_limit', '-1');
+
+$processor = AutoProcessor::fromPretrained('Xenova/yolov9-c_all');
+$model = AutoModel::fromPretrained('Xenova/yolov9-c_all');
+
+$image = Image::read(__DIR__.'/../images/multitask.png');
+
+$inputs = $processor($image);
+
+['outputs' => $outputs] = $model($inputs);
+
+$boxes = array_map(function ($args) use ($inputs, $model): ?array {
+    [$xmin, $ymin, $xmax, $ymax, $score, $id] = $args;
+
+    if ($score < 0.11) return null;
+
+    return [
+        'xmin' => $xmin,
+        'ymin' => $ymin,
+        'xmax' => $xmax,
+        'ymax' => $ymax,
+        'score' => $score,
+        'label' => $model->config['id2label'][$id] ?? 'unknown',
+    ];
+}, $outputs->toArray());
+
+$boxes = array_filter($boxes);
+
+$fontSize = 10;
+$fontScalingFactor = 0.75;
+$fontFile = '/Users/Kyrian/Library/Fonts/JosefinSans-Bold.ttf';
+$labelBoxHeight = $fontSize * 2 * $fontScalingFactor;
+$colors = array_map(fn () => sprintf('#%06x', mt_rand(0, 0xFFFFFF)), range(0, count($boxes) - 1));
+
+foreach ($boxes as $box) {
+    $detectionLabel = $box['label'].'  '.round($box['score'], 2);
+    $color = $colors[array_search($box, $boxes)];
+
+    $image = $image
+        ->drawRectangle($box['xmin'], $box['ymin'], $box['xmax'], $box['ymax'], $color, thickness: 2)
+        ->drawRectangle(
+            xMin: $box['xmin'],
+            yMin: max($box['ymin'] - $labelBoxHeight, 0),
+            xMax: $box['xmin'] + (strlen($detectionLabel) * $fontSize * $fontScalingFactor),
+            yMax: max($box['ymin'], $labelBoxHeight),
+            color: $color,
+            fill: true,
+            thickness: 2
+        )
+        ->drawText(
+            text: $detectionLabel,
+            xPos: $box['xmin'] + 5,
+            yPos: max($box['ymin'] - $labelBoxHeight, 0),
+            fontFile: $fontFile,
+            fontSize: $fontSize,
+            color: 'FFFFFF'
+        );
+}
+
+$image->save(__DIR__.'/../images/corgi-detected.jpg');

examples/misc/custom-object-detection.php

@@ -13,7 +13,7 @@
 
 $detector = pipeline('object-detection', 'Xenova/detr-resnet-50');
 
-$img = __DIR__ . '/../images/cats.jpg';
+$img = __DIR__.'/../images/cats.jpg';
 
 $output = $detector($img, threshold: 0.9);
 
@@ -23,8 +23,8 @@
 //
 //foreach ($output as $item) {
 //    $box = $item['box'];
-//    $image->drawRectangle($box['xmin'], $box['ymin'], $box['xmax'], $box['ymax'], '0099FF', thickness: 2);
-//    $image->drawText($item['label'], $box['xmin'], max($box['ymin'] - 5, 0), '/Users/Kyrian/Library/Fonts/JosefinSans-Bold.ttf', 14, '0099FF');
+//    $image = $image->drawRectangle($box['xmin'], $box['ymin'], $box['xmax'], $box['ymax'], '0099FF', thickness: 2);
+//    $image = $image->drawText($item['label'], $box['xmin'], max($box['ymin'] - 5, 0), '/Users/Kyrian/Library/Fonts/JosefinSans-Bold.ttf', 14, '0099FF');
 //}
 //
 //$image->save(__DIR__ . '/../images/cats-detection.jpg');

examples/pipelines/custom-object-detection.php

@@ -1,4 +1,4 @@
-DOWNLOADER=1.0.0
+DOWNLOADER=2.0.0
 OPENBLAS=0.3.27
 RINDOW_MATLIB=1.0.1
 ONNXRUNTIME=1.17.0

examples/pipelines/object-detection.php

@@ -9,6 +9,7 @@
 use Codewithkyrian\TransformersLibrariesDownloader\Libraries;
 use FFI;
 use FFI\CData;
+use RuntimeException;
 
 class FastTransformersUtils
 {
@@ -17,13 +18,22 @@ class FastTransformersUtils
     private static function ffi(): FFI
     {
         if (!isset(self::$ffi)) {
+            self::validateLibrary();
+
             $headerCode = file_get_contents(Libraries::FastTransformersUtils->headerFile(Transformers::$libsDir));
             self::$ffi = FFI::cdef($headerCode, Libraries::FastTransformersUtils->libFile(Transformers::$libsDir));
         }
 
         return self::$ffi;
     }
 
+    private static function validateLibrary(): void
+    {
+        if (!Libraries::FastTransformersUtils->exists(Transformers::$libsDir)) {
+            throw new RuntimeException('FastTransformersUtils library not found. Please run "./vendor/bin/transformers install" to install all dependencies.');
+        }
+    }
+
     public static function new($type, bool $owned = true, bool $persistent = false): ?CData
     {
         return self::ffi()->new($type, $owned, $persistent);

libs/VERSIONS

@@ -16,13 +16,22 @@ class OnnxRuntime
     public static function ffi(): FFI
     {
         if (!isset(self::$ffi)) {
+            self::validateLibrary();
+
             $headerCode = file_get_contents(Libraries::OnnxRuntime->headerFile(Transformers::$libsDir));
             self::$ffi = FFI::cdef($headerCode, Libraries::OnnxRuntime->libFile(Transformers::$libsDir));
         }
 
         return self::$ffi;
     }
 
+    private static function validateLibrary(): void
+    {
+        if (!Libraries::OnnxRuntime->exists(Transformers::$libsDir)) {
+            throw new RuntimeException("OnnxRuntime library not found. Please run \033[32m`./vendor/bin/transformers install`\033[39m to install all dependencies.");
+        }
+    }
+
     public static function api(): mixed
     {
         if (!isset(self::$api)) {

src/FFI/FastTransformersUtils.php

@@ -18,13 +18,22 @@ class Samplerate
     private static function ffi(): FFI
     {
         if (!isset(self::$ffi)) {
+            self::validateLibrary();
+
             $headerCode = file_get_contents(Libraries::Samplerate->headerFile(Transformers::$libsDir));
             self::$ffi = FFI::cdef($headerCode, Libraries::Samplerate->libFile(Transformers::$libsDir));
         }
 
         return self::$ffi;
     }
 
+    private static function validateLibrary(): void
+    {
+        if (!Libraries::Samplerate->exists(Transformers::$libsDir)) {
+            throw new RuntimeException('Samplerate library not found. Please run "./vendor/bin/transformers install" to install all dependencies.');
+        }
+    }
+
     public static function new($type, bool $owned = true, bool $persistent = false): ?CData
     {
         return self::ffi()->new($type, $owned, $persistent);

src/FFI/OnnxRuntime.php

@@ -2,7 +2,6 @@
 
 declare(strict_types=1);
 
-
 namespace Codewithkyrian\Transformers\FFI;
 
 use Codewithkyrian\Transformers\Transformers;
@@ -18,13 +17,22 @@ class Sndfile
     private static function ffi(): FFI
     {
         if (!isset(self::$ffi)) {
+            self::validateLibrary();
+
             $headerCode = file_get_contents(Libraries::Sndfile->headerFile(Transformers::$libsDir));
             self::$ffi = FFI::cdef($headerCode, Libraries::Sndfile->libFile(Transformers::$libsDir));
         }
 
         return self::$ffi;
     }
 
+    private static function validateLibrary(): void
+    {
+        if (!Libraries::Sndfile->exists(Transformers::$libsDir)) {
+            throw new RuntimeException('Sndfile library not found. Please run "./vendor/bin/transformers install" to install all dependencies.');
+        }
+    }
+
     public static function new($type, bool $owned = true, bool $persistent = false): ?CData
     {
         return self::ffi()->new($type, $owned, $persistent);
@@ -37,9 +45,11 @@ public static function enum(string $name)
 
     /**
      * Open the specified file for read, write or both.
+     *
      * @param string $path
      * @param int $mode
      * @param CData $sfinfo
+     *
      * @return mixed
      */
     public static function open(string $path, int $mode, CData $sfinfo): mixed