Merge branch '2.5' into 3.0

Author: andrewdalpino

composer.json

@@ -80,7 +80,7 @@
             "@test",
             "@check"
         ],
-        "analyze": "phpstan analyse -c phpstan.neon",
+        "analyze": "phpstan analyse -c phpstan.neon --memory-limit 1G",
         "benchmark": "phpbench run --report=aggregate",
         "check": [
             "@putenv PHP_CS_FIXER_IGNORE_ENV=1",

docs/backends/swoole.md

@@ -0,0 +1,18 @@
+<span style="float:right;"><a href="https://github.com/RubixML/ML/blob/master/src/Backends/Swoole.php">[source]</a></span>
+
+# Swoole
+[Swoole](https://swoole.com)/[OpenSwoole](https://openswoole.com/) is an async PHP extension that also supports multiprocessing.
+
+!!! tip
+    Swoole backend makes use of [Igbinary](https://www.php.net/manual/en/intro.igbinary.php) serializer. If you need to
+    optimize the memory usage (or getting out-of-memory errors) consider installing [Igbinary](https://www.php.net/manual/en/intro.igbinary.php).
+
+## Example
+
+No parameters are required. It's a drop-in replacement for the [Serial](backends/serial.md) backend.
+
+```php
+use Rubix\ML\Backends\Swoole;
+
+$backend = new Swoole();
+```

docs/persisters/filesystem.md

@@ -8,14 +8,37 @@ Filesystems are local or remote storage drives that are organized by files and f
 |---|---|---|---|---|
 | 1 | path | | string | The path to the model file on the filesystem. |
 | 2 | history | false | bool | Should we keep a history of past saves? |
-| 3 | serializer | RBX | Serializer | The serializer used to convert to and from storage format. |
 
 ## Example
 ```php
 use Rubix\ML\Persisters\Filesystem;
 use Rubix\ML\Serializers\RBX;
+use Rubix\ML\Classifiers\KNearestNeighbors;
+use Rubix\ML\Kernels\Distance\Manhattan;
 
-$persister = new Filesystem('/path/to/example.model', true, new RBX());
+$persistable = new KNearestNeighbors(3, false, new Manhattan());
+
+$persister = new Filesystem('/path/to/example.rbx', true);
+
+$serializer = new RBX(6);
+
+$encoding = $serializer->serialize($persistable);
+
+$persister->save($encoding);
+```
+
+## Example
+```php
+use Rubix\ML\Persisters\Filesystem;
+use Rubix\ML\Serializers\RBX;
+
+$persister = new Filesystem('/path/to/example.rbx', true);
+
+$encoding = $persister->load();
+
+$serializer = new RBX(6);
+
+$persistable = $serializer->deserialize($encoding);
 ```
 
 ## Additional Methods

src/AnomalyDetectors/LocalOutlierFactor.php

@@ -104,7 +104,7 @@ class LocalOutlierFactor implements Estimator, Learner, Scoring, Persistable
     /**
      * @param int $k
      * @param float|null $contamination
-     * @param \Rubix\ML\Graph\Trees\Spatial|null $tree
+     * @param Spatial|null $tree
      * @throws InvalidArgumentException
      */
     public function __construct(int $k = 20, ?float $contamination = null, ?Spatial $tree = null)

src/AnomalyDetectors/Loda.php

@@ -98,7 +98,7 @@ class Loda implements Estimator, Learner, Online, Scoring, Persistable
     /**
      * The sparse random projection matrix.
      *
-     * @var \Tensor\Matrix|null
+     * @var Matrix|null
      */
     protected ?Matrix $r = null;
 

src/AnomalyDetectors/OneClassSVM.php

@@ -56,13 +56,13 @@ class OneClassSVM implements Estimator, Learner
     /**
      * The trained model instance.
      *
-     * @var \svmmodel|null
+     * @var svmmodel|null
      */
     protected ?svmmodel $model = null;
 
     /**
      * @param float $nu
-     * @param \Rubix\ML\Kernels\SVM\Kernel|null $kernel
+     * @param Kernel|null $kernel
      * @param bool $shrinking
      * @param float $tolerance
      * @param float $cacheSize

src/Backends/Swoole.php

@@ -98,7 +98,10 @@ function (Process $worker) use ($maxMessageLength, $queueItem) {
                 true,
             );
 
-            $workerProcess->setAffinity([$currentCpu]);
+            if (method_exists($workerProcess, 'setAffinity')) {
+                $workerProcess->setAffinity([$currentCpu]);
+            }
+
             $workerProcess->setBlocking(false);
             $workerProcess->start();
 

src/Classifiers/AdaBoost.php

@@ -145,7 +145,7 @@ class AdaBoost implements Estimator, Learner, Probabilistic, Verbose, Persistabl
     protected ?int $featureCount = null;
 
     /**
-     * @param \Rubix\ML\Learner|null $base
+     * @param Learner|null $base
      * @param float $rate
      * @param float $ratio
      * @param int $epochs

src/Classifiers/KDNeighbors.php

@@ -81,7 +81,7 @@ class KDNeighbors implements Estimator, Learner, Probabilistic, Persistable
     /**
      * @param int $k
      * @param bool $weighted
-     * @param \Rubix\ML\Graph\Trees\Spatial|null $tree
+     * @param Spatial|null $tree
      * @throws InvalidArgumentException
      */
     public function __construct(int $k = 5, bool $weighted = false, ?Spatial $tree = null)

src/Classifiers/KNearestNeighbors.php

@@ -94,7 +94,7 @@ class KNearestNeighbors implements Estimator, Learner, Online, Probabilistic, Pe
     /**
      * @param int $k
      * @param bool $weighted
-     * @param \Rubix\ML\Kernels\Distance\Distance|null $kernel
+     * @param Distance|null $kernel
      * @throws InvalidArgumentException
      */
     public function __construct(int $k = 5, bool $weighted = false, ?Distance $kernel = null)