Revamp model internals, unify generation flow, and extend platform support

.github/workflows/build-rindow-matlib.yml

@@ -0,0 +1,52 @@
+name: Build Rindow Matlib
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build rindow-matlib (${{ matrix.arch }})
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - arch: x86_64
+            runs-on: ubuntu-24.04
+            artifact_name: linux-x86_64
+          - arch: arm64
+            runs-on: ubuntu-24.04-arm
+            artifact_name: linux-arm64
+
+    runs-on: ${{ matrix.runs-on }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          repository: rindow/rindow-matlib
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y build-essential cmake
+
+      - name: Build
+        run: |
+          cmake -S . -B build
+          cmake --build build --config Release
+
+      - name: Run tests
+        run: |
+          cd build
+          ctest -C Release
+
+      - name: Package
+        run: |
+          cd build
+          cpack -G TGZ -C Release
+
+      - name: Upload package artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.artifact_name }}
+          path: packages/*

.github/workflows/tests.yml

@@ -0,0 +1,40 @@
+name: Tests
+
+on: ['push', 'pull_request']
+
+jobs:
+  ci:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        php: [8.1, 8.2, 8.3, 8.4]
+      max-parallel: 4
+
+    name: Tests PHP${{ matrix.php }} - ${{ matrix.os }}
+
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.composer/cache/files
+          key: dependencies-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, mbstring, zip, ffi
+          coverage: none
+
+      - name: Install Composer dependencies
+        run: composer update --no-interaction --prefer-dist
+
+      - name: Run Tests
+        run: composer test

README.md

@@ -11,26 +11,18 @@
 <a href="https://packagist.org/packages/codewithkyrian/transformers"><img src="https://img.shields.io/packagist/v/codewithkyrian/transformers" alt="Latest Stable Version"></a>
 <a href="https://github.com/CodeWithKyrian/transformers-php/blob/main/LICENSE"><img src="https://img.shields.io/github/license/codewithkyrian/transformers-php" alt="License"></a>
 <a href="https://github.com/codewithkyrian/transformers-php"><img src="https://img.shields.io/github/repo-size/codewithkyrian/transformers-php" alt="Documentation"></a>
+<a href="https://github.com/CodeWithKyrian/transformers-php/actions/workflows/tests.yml"><img src="https://github.com/CodeWithKyrian/transformers-php/actions/workflows/tests.yml/badge.svg" alt="Tests"></a>
 </p>
 
-TransformersPHP is designed to be functionally equivalent to the Python library, while still maintaining the same level
-of performance and ease of use. This library is built on top of the Hugging Face's Transformers library, which provides
-thousands of pre-trained models in 100+ languages. It is designed to be a simple and easy-to-use library for PHP
-developers using a similar API to the Python library. These models can be used for a variety of tasks, including text
-generation, summarization, translation, and more.
+TransformersPHP is designed to be functionally equivalent to the Python library, while still maintaining the same level of performance and ease of use. This library is built on top of the Hugging Face's Transformers library, which provides thousands of pre-trained models in 100+ languages. It is designed to be a simple and easy-to-use library for PHP developers using a similar API to the Python library. These models can be used for a variety of tasks, including text generation, summarization, translation, and more.
 
-TransformersPHP uses [ONNX Runtime](https://onnxruntime.ai/) to run the models, which is a high-performance scoring
-engine for Open Neural Network Exchange (ONNX) models. You can easily convert any PyTorch or TensorFlow model to ONNX
-and use it with TransformersPHP using [🤗 Optimum](https://github.com/huggingface/optimum#onnx--onnx-runtime).
+TransformersPHP uses [ONNX Runtime](https://onnxruntime.ai/) to run the models, which is a high-performance scoring engine for Open Neural Network Exchange (ONNX) models. You can easily convert any PyTorch or TensorFlow model to ONNX and use it with TransformersPHP using [🤗 Optimum](https://github.com/huggingface/optimum#onnx--onnx-runtime).
 
-TO learn more about the library and how it works, head over to
-our [extensive documentation](https://codewithkyrian.github.io/transformers-php/introduction).
+TO learn more about the library and how it works, head over to our [extensive documentation](https://codewithkyrian.github.io/transformers-php/introduction).
 
 ## Quick tour
 
-Because TransformersPHP is designed to be functionally equivalent to the Python library, it's super easy to learn from
-existing Python or Javascript code. We provide the `pipeline` API, which is a high-level, easy-to-use API that groups
-together a model with its necessary preprocessing and postprocessing steps.
+Because TransformersPHP is designed to be functionally equivalent to the Python library, it's super easy to learn from existing Python or Javascript code. We provide the `pipeline` API, which is a high-level, easy-to-use API that groups together a model with its necessary preprocessing and postprocessing steps.
 
 <table>
 <tr>
@@ -104,15 +96,11 @@ composer require codewithkyrian/transformers
 ```
 
 > [!CAUTION]
-> The ONNX library is platform-specific, so it's important to run the composer require command on the target platform
-> where the code will be executed. In most cases, this will be your development machine or a server where you deploy
-> your application, but if you're using a Docker container, run the `composer require` command inside that container.
+> The ONNX library is platform-specific, so it's important to run the composer require command on the target platform where the code will be executed. In most cases, this will be your development machine or a server where you deploy your application, but if you're using a Docker container, run the `composer require` command inside that container.
 
 ## PHP FFI Extension
 
-TransformersPHP uses the PHP FFI extension to interact with the ONNX runtime. The FFI extension is included by default
-in PHP 7.4 and later, but it may not be enabled by default. If the FFI extension is not enabled, you can enable it by
-uncommenting(remove the `;` from the beginning of the line) the
+TransformersPHP uses the PHP FFI extension to interact with the ONNX runtime. The FFI extension is included by default in PHP 7.4 and later, but it may not be enabled by default. If the FFI extension is not enabled, you can enable it by uncommenting(remove the `;` from the beginning of the line) the
 following line in your `php.ini` file:
 
 ```ini
@@ -129,14 +117,11 @@ After making these changes, restart your web server or PHP-FPM service, and you
 
 ## Documentation
 
-For more detailed information on how to use the library, check out the
-documentation : [https://codewithkyrian.github.io/transformers-php](https://codewithkyrian.github.io/transformers-php)
+For more detailed information on how to use the library, check out the documentation : [https://codewithkyrian.github.io/transformers-php](https://codewithkyrian.github.io/transformers-php)
 
 ## Usage
 
-By default, TransformersPHP uses hosted pretrained ONNX models. For supported tasks, models that have been converted to
-work with [Xenova's Transformers.js](https://huggingface.co/models?library=transformers.js) on HuggingFace should work
-out of the box with TransformersPHP.
+By default, TransformersPHP uses hosted pretrained ONNX models. For supported tasks, models that have been converted to work with [Xenova's Transformers.js](https://huggingface.co/models?library=transformers.js) on HuggingFace should work out of the box with TransformersPHP.
 
 ## Configuration
 
@@ -151,27 +136,25 @@ Transformers::setup()
     ->setRemotePathTemplate('...') // Set the remote path template for downloading models. Defaults to `{model}/resolve/{revision}/{file}`
     ->setAuthToken('...') // Set the auth token for downloading models. Defaults to `null`
     ->setUserAgent('...') // Set the user agent for downloading models. Defaults to `transformers-php/{version}`
-    ->setImageDriver('...') // Set the image driver for processing images. Defaults to `IMAGICK'
-    ->setLogger('...'); // Set the logger for TransformersPHP. Defaults to `null`
+    ->setImageDriver('...') // Set the image driver for processing images. Defaults to `VIPS`
+    ->setLogger($logger) // Set a PSR-3 compatible logger. Defaults to `NullLogger` if not set
+    ->apply(); // Apply the configuration
 ```
 
-You can call the `set` methods in any order, or leave any out entirely, in which case, it uses the default values. For
-more information on the configuration options and what they mean, checkout
+You can call the `set` methods in any order, or leave any out entirely, in which case, it uses the default values. For more information on the configuration options and what they mean, checkout
 the [documentation](https://codewithkyrian.github.io/transformers-php/configuration).
 
 ## Convert your models to ONNX
 
-TransformersPHP only works with ONNX models, therefore, you must convert your PyTorch, TensorFlow or JAX models to
-ONNX. It is recommended to use [🤗 Optimum](https://huggingface.co/docs/optimum) to perform the conversion and
-quantization of your model.
+TransformersPHP only works with ONNX models, therefore, you must convert your PyTorch, TensorFlow or JAX models to ONNX. We recommend using the [conversion script](https://github.com/huggingface/transformers.js/blob/main/scripts/convert.py) from Transformers.js, which uses the  [🤗 Optimum](https://huggingface.co/docs/optimum) behind the scenes to perform the conversion and quantization of your model.
+
+```
+python -m convert --quantize --model_id <model_name_or_path>
+```
 
 ## Pre-Download Models
 
-By default, TransformersPHP automatically retrieves model weights (ONNX format) from the Hugging Face model hub when
-you first use a pipeline or pretrained model. This can lead to a slight delay during the initial use. To improve the
-user experience, it's recommended to pre-download the models you intend to use before running them in your PHP
-application, especially for larger models. One way to do that is run the request once manually, but TransformersPHP
-also comes with a command line tool to help you do just that:
+By default, TransformersPHP automatically retrieves model weights (ONNX format) from the Hugging Face model hub when you first use a pipeline or pretrained model. This can lead to a slight delay during the initial use. To improve the user experience, it's recommended to pre-download the models you intend to use before running them in your PHP application, especially for larger models. One way to do that is run the request once manually, but TransformersPHP also comes with a command line tool to help you do just that:
 
 ```bash
 ./vendor/bin/transformers download <model_identifier> [<task>] [options]

bin/transformers

@@ -1,22 +1,21 @@
 #!/usr/bin/env php
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 use Symfony\Component\Console\Application;
 
 require_once $_composer_autoload_path ?? __DIR__ . '/../vendor/autoload.php';
 
 $application = new Application();
 
-// ... register commands
-
 try {
     $application->setName('Transformers PHP CLI');
 
-    $application->add(new Codewithkyrian\Transformers\Commands\InstallCommand());
-    $application->add(new Codewithkyrian\Transformers\Commands\DownloadModelCommand());
+    $application->addCommand(new Codewithkyrian\Transformers\Commands\DownloadModelCommand());
 
     $application->run();
 } catch (Exception $e) {
     echo $e->getMessage();
     exit(1);
-}
+}

composer.json

@@ -11,28 +11,28 @@
     "php",
     "codewithkyrian"
   ],
-  "type": "library",
+  "type": "platform-package",
   "require": {
     "php": "^8.1",
     "ext-ffi": "*",
-    "psr/log": "^1.1.3|^2.0|^3.0",
-    "codewithkyrian/jinja-php": "^1.0",
-    "codewithkyrian/transformers-libsloader": "^2.0",
+    "codewithkyrian/jinja-php": "^2.0",
+    "codewithkyrian/platform-package-installer": "^1.0",
     "imagine/imagine": "^1.3",
-    "rindow/rindow-math-matrix": "^2.0",
-    "rindow/rindow-matlib-ffi": "^1.0",
+    "psr/log": "^1.1 || ^2.0 || ^3.0",
+    "rindow/rindow-math-matrix": "^2.1",
+    "rindow/rindow-matlib-ffi": "^1.1",
     "rindow/rindow-openblas-ffi": "^1.0",
-    "symfony/console": "^6.4|^7.0",
-    "rokka/imagine-vips": "^0.31.0"
+    "rokka/imagine-vips": "^0.40",
+    "symfony/console": "^6.4|^7.0"
   },
   "require-dev": {
-    "pestphp/pest": "^2.31",
-    "symfony/var-dumper": "^7.0"
+    "ffi/var-dumper": "^1.0",
+    "pestphp/pest": "^2.36.0|^3.5.0",
+    "symfony/var-dumper": "^6.4.11|^7.1.5"
   },
   "suggest": {
     "ext-imagick": "Required to use the Imagick Driver for image processing",
-    "ext-gd": "Required to use the GD Driver for image processing",
-    "rokka/imagine-vips": "Required to use the VIPS Driver for image processing"
+    "ext-gd": "Required to use the GD Driver for image processing"
   },
   "license": "Apache-2.0",
   "autoload": {
@@ -51,23 +51,31 @@
     }
   ],
   "config": {
+    "sort-packages": true,
     "allow-plugins": {
       "pestphp/pest-plugin": true,
-      "codewithkyrian/transformers-libsloader": true
+      "codewithkyrian/platform-package-installer": true
     }
   },
   "bin": [
     "bin/transformers"
   ],
   "scripts": {
     "test": "vendor/bin/pest",
-    "test:coverage": "XDEBUG_MODE=coverage ./vendor/bin/pest --coverage",
-    "post-install-cmd": "Codewithkyrian\\Transformers\\Utils\\LibsChecker::check",
-    "post-update-cmd": "Codewithkyrian\\Transformers\\Utils\\LibsChecker::check"
+    "test:coverage": "XDEBUG_MODE=coverage ./vendor/bin/pest --coverage"
   },
   "archive": {
     "exclude": [
       "/docs"
     ]
+  },
+  "extra": {
+    "platform-urls": {
+      "linux-x86_64": "https://github.com/codewithkyrian/transformers-php/releases/download/{version}/dist-linux-x86_64.tar.gz",
+      "linux-arm64": "https://github.com/codewithkyrian/transformers-php/releases/download/{version}/dist-linux-arm64.tar.gz",
+      "darwin-x86_64": "https://github.com/codewithkyrian/transformers-php/releases/download/{version}/dist-darwin-x86_64.tar.gz",
+      "darwin-arm64": "https://github.com/codewithkyrian/transformers-php/releases/download/{version}/dist-darwin-arm64.tar.gz",
+      "windows-x86_64": "https://github.com/codewithkyrian/transformers-php/releases/download/{version}/dist-windows-x86_64.zip"
+    }
   }
-}
+}