Merge remote-tracking branch 'origin/main' into audio-features

Author: CodeWithKyrian

CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to `transformers-php` will be documented in this file.
 
+## v0.4.1 - 2024-05-24
+
+### What's Changed
+
+* configuration.md: fix indentation of Transformers::setup() by @k00ni in https://github.com/CodeWithKyrian/transformers-php/pull/35
+* PretrainedTokenizer::truncateHelper: prevent array_slice() error for flawed text input (summarization) by @k00ni in https://github.com/CodeWithKyrian/transformers-php/pull/36
+* Fix bug with Download CLI - use named parameters for model construct by @CodeWithKyrian in https://github.com/CodeWithKyrian/transformers-php/pull/39
+
+### New Contributors
+
+* @k00ni made their first contribution in https://github.com/CodeWithKyrian/transformers-php/pull/35
+
+**Full Changelog**: https://github.com/CodeWithKyrian/transformers-php/compare/0.4.0...0.4.1
+
 ## v0.3.1 - 2024-04-22
 
 ### What's Changed
@@ -95,6 +109,7 @@ composer require codewithkyrian/transformers
 
 
 
+
 ```
 And you must initialize the library to download neccesary libraries for ONNX
 
@@ -106,6 +121,7 @@ And you must initialize the library to download neccesary libraries for ONNX
 
 
 
+
 ```
 #### Checkout the Documentation
 
@@ -123,6 +139,7 @@ To ensure a smooth user experience, especially with larger models, we recommend
 
 
 
+
 ```
 #### What's Next?
 

docs/configuration.md

@@ -16,7 +16,7 @@ models, and the remote path template. These settings allow you to tailor how and
 use Codewithkyrian\Transformers\Transformers;
 use Codewithkyrian\Transformers\Utils\ImageDriver;
 
- Transformers::setup()
+Transformers::setup()
         ->setCacheDir('/path/to/models')
         ->setImageDriver(ImageDriver::IMAGICK)
         ->setRemoteHost('https://yourmodelshost.com')
@@ -198,4 +198,4 @@ public function boot()
 
 Now that you've learned how to configure TransformersPHP, you can start using the library to download and use
 pre-trained ONNX models. For more information on how to use the library, check out
-the [Getting Started](getting-started.md) guide.
+the [Getting Started](getting-started.md) guide.

src/Models/Pretrained/PretrainedModel.php

@@ -85,7 +85,7 @@ public static function fromPretrained(
         string            $revision = 'main',
         ?string           $modelFilename = null,
         ModelArchitecture $modelArchitecture = ModelArchitecture::EncoderOnly,
-        ?callable $onProgress = null
+        ?callable         $onProgress = null
     ): self
     {
         if (is_array($config)) {
@@ -116,7 +116,12 @@ public static function fromPretrained(
 
                 $generatorConfig = new GenerationConfig($generatorConfigArr);
 
-                return new static($config, $session, $modelArchitecture, $generatorConfig);
+                return new static(
+                    config: $config,
+                    session: $session,
+                    modelArchitecture: $modelArchitecture,
+                    generationConfig: $generatorConfig
+                );
             }
 
             case ModelArchitecture::Seq2SeqLM:
@@ -149,8 +154,13 @@ public static function fromPretrained(
 
                 $generatorConfig = new GenerationConfig($generatorConfigArr);
 
-
-                return new static($config, $encoderSession, $decoderSession, $modelArchitecture, $generatorConfig);
+                return new static(
+                    config: $config,
+                    session: $encoderSession,
+                    modelArchitecture: $modelArchitecture,
+                    generationConfig: $generatorConfig,
+                    decoderMergedSession: $decoderSession
+                );
             }
 
             case ModelArchitecture::MaskGeneration:
@@ -171,7 +181,12 @@ public static function fromPretrained(
                     onProgress: $onProgress
                 );
 
-                return new static($config, $visionEncoder, $promptMaskEncoder, $modelArchitecture);
+                return new static(
+                    config: $config,
+                    session: $visionEncoder,
+                    promptMaskEncoderSession: $promptMaskEncoder,
+                    modelArchitecture: $modelArchitecture
+                );
             }
 
             case ModelArchitecture::EncoderDecoder:
@@ -192,7 +207,12 @@ public static function fromPretrained(
                     onProgress: $onProgress
                 );
 
-                return new static($config, $encoderSession, $decoderSession, $modelArchitecture);
+                return new static(
+                    config: $config,
+                    session: $encoderSession,
+                    decoderMergedSession: $decoderSession,
+                    modelArchitecture: $modelArchitecture
+                );
             }
 
             default:
@@ -211,7 +231,11 @@ public static function fromPretrained(
                 );
 
 
-                return new static($config, $session, $modelArchitecture);
+                return new static(
+                    config: $config,
+                    session: $session,
+                    modelArchitecture: $modelArchitecture
+                );
             }
         }
     }
@@ -233,14 +257,14 @@ public static function fromPretrained(
      */
 
     public static function constructSession(
-        string           $modelNameOrPath,
-        string           $fileName,
-        ?string          $cacheDir = null,
-        string           $revision = 'main',
-        string           $subFolder = 'onnx',
-        bool             $fatal = true,
+        string    $modelNameOrPath,
+        string    $fileName,
+        ?string   $cacheDir = null,
+        string    $revision = 'main',
+        string    $subFolder = 'onnx',
+        bool      $fatal = true,
         ?callable $onProgress = null,
-                         ...$sessionOptions
+                  ...$sessionOptions
     ): ?InferenceSession
     {
         $modelFileName = "$fileName.onnx";

src/PretrainedTokenizers/PretrainedTokenizer.php

@@ -468,6 +468,10 @@ function truncateHelper(array &$item, int $length): void
         // Setting .length to a lower value truncates the array in-place.
         // Note: In PHP, arrays automatically adjust their size, so we don't need to explicitly set the length.
         foreach (array_keys($item) as $key) {
+            if (false == $item[$key]) {
+                continue;
+            }
+
             $item[$key] = array_slice($item[$key], 0, $length);
         }
     }