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)

src/Classifiers/LogisticRegression.php

@@ -110,11 +110,7 @@ class LogisticRegression implements Estimator, Learner, Online, Probabilistic, R
      *
      * @var \Rubix\ML\NeuralNet\Network|null
      */
-<<<<<<< HEAD
     protected ?\Rubix\ML\NeuralNet\Network $network = null;
-=======
-    protected ?FeedForward $network = null;
->>>>>>> 2.5
 
     /**
      * The unique class labels.
@@ -132,12 +128,12 @@ class LogisticRegression implements Estimator, Learner, Online, Probabilistic, R
 
     /**
      * @param int $batchSize
-     * @param \Rubix\ML\NeuralNet\Optimizers\Optimizer|null $optimizer
+     * @param Optimizer|null $optimizer
      * @param float $l2Penalty
      * @param int $epochs
      * @param float $minChange
      * @param int $window
-     * @param \Rubix\ML\NeuralNet\CostFunctions\ClassificationLoss|null $costFn
+     * @param ClassificationLoss|null $costFn
      * @throws InvalidArgumentException
      */
     public function __construct(

src/Classifiers/LogitBoost.php

@@ -183,15 +183,15 @@ class LogitBoost implements Estimator, Learner, Probabilistic, RanksFeatures, Ve
     protected ?int $featureCount = null;
 
     /**
-     * @param \Rubix\ML\Learner|null $booster
+     * @param Learner|null $booster
      * @param float $rate
      * @param float $ratio
      * @param int $epochs
      * @param float $minChange
      * @param int $evalInterval
      * @param int $window
      * @param float $holdOut
-     * @param \Rubix\ML\CrossValidation\Metrics\Metric|null $metric
+     * @param Metric|null $metric
      * @throws InvalidArgumentException
      */
     public function __construct(

src/Classifiers/MultilayerPerceptron.php

@@ -141,11 +141,7 @@ class MultilayerPerceptron implements Estimator, Learner, Online, Probabilistic,
      *
      * @var \Rubix\ML\NeuralNet\Network|null
      */
-<<<<<<< HEAD
     protected ?\Rubix\ML\NeuralNet\Network $network = null;
-=======
-    protected ?FeedForward $network = null;
->>>>>>> 2.5
 
     /**
      * The unique class labels.
@@ -171,14 +167,19 @@ class MultilayerPerceptron implements Estimator, Learner, Online, Probabilistic,
     /**
      * @param \Rubix\ML\NeuralNet\Layers\Hidden[] $hiddenLayers
      * @param int $batchSize
+<<<<<<< HEAD
      * @param \Rubix\ML\NeuralNet\Optimizers\Optimizer|null $optimizer
+=======
+     * @param Optimizer|null $optimizer
+     * @param float $l2Penalty
+>>>>>>> 2.5
      * @param int $epochs
      * @param float $minChange
      * @param int $evalInterval
      * @param int $window
      * @param float $holdOut
-     * @param \Rubix\ML\NeuralNet\CostFunctions\ClassificationLoss|null $costFn
-     * @param \Rubix\ML\CrossValidation\Metrics\Metric|null $metric
+     * @param ClassificationLoss|null $costFn
+     * @param Metric|null $metric
      * @throws InvalidArgumentException
      */
     public function __construct(

src/Classifiers/RadiusNeighbors.php

@@ -89,7 +89,7 @@ class RadiusNeighbors implements Estimator, Learner, Probabilistic, Persistable
      * @param float $radius
      * @param bool $weighted
      * @param string $outlierClass
-     * @param \Rubix\ML\Graph\Trees\Spatial|null $tree
+     * @param Spatial|null $tree
      * @throws InvalidArgumentException
      */
     public function __construct(

src/Classifiers/RandomForest.php

@@ -118,7 +118,7 @@ class RandomForest implements Estimator, Learner, Probabilistic, Parallel, Ranks
     protected ?int $featureCount = null;
 
     /**
-     * @param \Rubix\ML\Learner|null $base
+     * @param Learner|null $base
      * @param int $estimators
      * @param float $ratio
      * @param bool $balanced

src/Classifiers/SVC.php

@@ -58,7 +58,7 @@ class SVC implements Estimator, Learner
     /**
      * The trained model instance.
      *
-     * @var \svmmodel|null
+     * @var svmmodel|null
      */
     protected $model;
 
@@ -73,7 +73,7 @@ class SVC implements Estimator, Learner
 
     /**
      * @param float $c
-     * @param \Rubix\ML\Kernels\SVM\Kernel|null $kernel
+     * @param Kernel|null $kernel
      * @param bool $shrinking
      * @param float $tolerance
      * @param float $cacheSize

src/Classifiers/SoftmaxClassifier.php

@@ -106,11 +106,7 @@ class SoftmaxClassifier implements Estimator, Learner, Online, Probabilistic, Ve
      *
      * @var \Rubix\ML\NeuralNet\Network|null
      */
-<<<<<<< HEAD
     protected ?\Rubix\ML\NeuralNet\Network $network = null;
-=======
-    protected ?FeedForward $network = null;
->>>>>>> 2.5
 
     /**
      * The unique class labels.
@@ -128,12 +124,12 @@ class SoftmaxClassifier implements Estimator, Learner, Online, Probabilistic, Ve
 
     /**
      * @param int $batchSize
-     * @param \Rubix\ML\NeuralNet\Optimizers\Optimizer|null $optimizer
+     * @param Optimizer|null $optimizer
      * @param float $l2Penalty
      * @param int $epochs
      * @param float $minChange
      * @param int $window
-     * @param \Rubix\ML\NeuralNet\CostFunctions\ClassificationLoss|null $costFn
+     * @param ClassificationLoss|null $costFn
      * @throws InvalidArgumentException
      */
     public function __construct(

src/Clusterers/DBSCAN.php

@@ -78,7 +78,7 @@ class DBSCAN implements Estimator
     /**
      * @param float $radius
      * @param int $minDensity
-     * @param \Rubix\ML\Graph\Trees\Spatial|null $tree
+     * @param Spatial|null $tree
      * @throws InvalidArgumentException
      */
     public function __construct(float $radius = 0.5, int $minDensity = 5, ?Spatial $tree = null)

src/Clusterers/FuzzyCMeans.php

@@ -122,8 +122,8 @@ class FuzzyCMeans implements Estimator, Learner, Probabilistic, Verbose, Persist
      * @param float $fuzz
      * @param int $epochs
      * @param float $minChange
-     * @param \Rubix\ML\Kernels\Distance\Distance|null $kernel
-     * @param Seeders\Seeder|null $seeder
+     * @param Distance|null $kernel
+     * @param Seeder|null $seeder
      * @throws InvalidArgumentException
      */
     public function __construct(

src/Clusterers/GaussianMixture.php

@@ -138,7 +138,7 @@ class GaussianMixture implements Estimator, Learner, Probabilistic, Verbose, Per
      * @param float $smoothing
      * @param int $epochs
      * @param float $minChange
-     * @param Seeders\Seeder|null $seeder
+     * @param Seeder|null $seeder
      * @throws InvalidArgumentException
      */
     public function __construct(

src/Clusterers/KMeans.php

@@ -136,8 +136,8 @@ class KMeans implements Estimator, Learner, Online, Probabilistic, Verbose, Pers
      * @param int $epochs
      * @param float $minChange
      * @param int $window
-     * @param \Rubix\ML\Kernels\Distance\Distance|null $kernel
-     * @param Seeders\Seeder|null $seeder
+     * @param Distance|null $kernel
+     * @param Seeder|null $seeder
      * @throws InvalidArgumentException
      */
     public function __construct(

src/Clusterers/MeanShift.php

@@ -139,7 +139,7 @@ class MeanShift implements Estimator, Learner, Probabilistic, Verbose, Persistab
      *
      * @param Dataset $dataset
      * @param float $percentile
-     * @param \Rubix\ML\Kernels\Distance\Distance|null $kernel
+     * @param Distance|null $kernel
      * @throws InvalidArgumentException
      * @return float
      */
@@ -175,8 +175,8 @@ public static function estimateRadius(
      * @param float $ratio
      * @param int $epochs
      * @param float $minShift
-     * @param \Rubix\ML\Graph\Trees\Spatial|null $tree
-     * @param Seeders\Seeder|null $seeder
+     * @param Spatial|null $tree
+     * @param Seeder|null $seeder
      * @throws InvalidArgumentException
      */
     public function __construct(

src/Clusterers/Seeders/KMC2.php

@@ -43,7 +43,7 @@ class KMC2 implements Seeder
 
     /**
      * @param int $m
-     * @param \Rubix\ML\Kernels\Distance\Distance|null $kernel
+     * @param Distance|null $kernel
      * @throws InvalidArgumentException
      */
     public function __construct(int $m = 50, ?Distance $kernel = null)

src/Clusterers/Seeders/PlusPlus.php

@@ -36,7 +36,7 @@ class PlusPlus implements Seeder
     protected Distance $kernel;
 
     /**
-     * @param \Rubix\ML\Kernels\Distance\Distance|null $kernel
+     * @param Distance|null $kernel
      */
     public function __construct(?Distance $kernel = null)
     {

src/Datasets/Generators/Blob.php

@@ -37,7 +37,7 @@ class Blob implements Generator
     /**
      * The standard deviation of the blob.
      *
-     * @var \Tensor\Vector|int|float
+     * @var Vector|int|float
      */
     protected $stdDev;