Bump version and fix coding style

RubixML · Dec 26, 2024 · 1f3d0cb · 1f3d0cb
1 parent 90e8122
commit 1f3d0cb
Show file tree

Hide file tree

Showing 208 changed files with 319 additions and 315 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+- 2.6.0
+    - You can now exclude certain categories from one-hot encoding.
+
 - 2.5.2
     - Fix bug in One-class SVM inferencing
 

diff --git a/src/AnomalyDetectors/GaussianMLE.php b/src/AnomalyDetectors/GaussianMLE.php
@@ -133,7 +133,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {

diff --git a/src/AnomalyDetectors/IsolationForest.php b/src/AnomalyDetectors/IsolationForest.php
@@ -97,7 +97,7 @@ class IsolationForest implements Estimator, Learner, Scoring, Persistable
     /**
      * The isolation trees that make up the forest.
      *
-     * @var \Rubix\ML\Graph\Trees\ITree[]
+     * @var ITree[]
      */
     protected array $trees = [
         //
@@ -162,7 +162,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {

diff --git a/src/AnomalyDetectors/Loda.php b/src/AnomalyDetectors/Loda.php
@@ -171,7 +171,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {

diff --git a/src/AnomalyDetectors/OneClassSVM.php b/src/AnomalyDetectors/OneClassSVM.php
@@ -139,7 +139,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {

diff --git a/src/AnomalyDetectors/RobustZScore.php b/src/AnomalyDetectors/RobustZScore.php
@@ -138,7 +138,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {

diff --git a/src/Backends/Amp.php b/src/Backends/Amp.php
@@ -104,7 +104,7 @@ public function enqueue(Task $task, ?callable $after = null, $context = null) :
      * @param AmpTask $task
      * @param callable(mixed,mixed):void $after
      * @param mixed $context
-     * @return \Generator<\Amp\Promise>
+     * @return Generator<\Amp\Promise>
      */
     public function coroutine(AmpTask $task, ?callable $after = null, $context = null) : Generator
     {
@@ -138,7 +138,7 @@ public function process() : array
      *
      * @internal
      *
-     * @return \Generator<\Amp\Promise>
+     * @return Generator<\Amp\Promise>
      */
     public function gather() : Generator
     {

diff --git a/src/BootstrapAggregator.php b/src/BootstrapAggregator.php
@@ -83,7 +83,7 @@ class BootstrapAggregator implements Estimator, Learner, Parallel, Persistable
     /**
      * The ensemble of estimators.
      *
-     * @var list<\Rubix\ML\Learner>
+     * @var list<Learner>
      */
     protected array $ensemble = [
         //
@@ -136,7 +136,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {

diff --git a/src/Classifiers/AdaBoost.php b/src/Classifiers/AdaBoost.php
@@ -112,7 +112,7 @@ class AdaBoost implements Estimator, Learner, Probabilistic, Verbose, Persistabl
     /**
      * The ensemble of *weak* classifiers.
      *
-     * @var \Rubix\ML\Learner[]|null
+     * @var Learner[]|null
      */
     protected ?array $ensemble = null;
 
@@ -255,7 +255,7 @@ public function trained() : bool
     /**
      * Return an iterable progress table with the steps from the last training session.
      *
-     * @return \Generator<mixed[]>
+     * @return Generator<mixed[]>
      */
     public function steps() : Generator
     {

diff --git a/src/Classifiers/ClassificationTree.php b/src/Classifiers/ClassificationTree.php
@@ -94,7 +94,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {

diff --git a/src/Classifiers/ExtraTreeClassifier.php b/src/Classifiers/ExtraTreeClassifier.php
@@ -93,7 +93,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {

diff --git a/src/Classifiers/GaussianNB.php b/src/Classifiers/GaussianNB.php
@@ -161,7 +161,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {

diff --git a/src/Classifiers/LogisticRegression.php b/src/Classifiers/LogisticRegression.php
@@ -196,7 +196,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {
@@ -238,7 +238,7 @@ public function trained() : bool
     /**
      * Return an iterable progress table with the steps from the last training session.
      *
-     * @return \Generator<mixed[]>
+     * @return Generator<mixed[]>
      */
     public function steps() : Generator
     {

diff --git a/src/Classifiers/LogitBoost.php b/src/Classifiers/LogitBoost.php
@@ -305,7 +305,7 @@ public function trained() : bool
     /**
      * Return an iterable progress table with the steps from the last training session.
      *
-     * @return \Generator<mixed[]>
+     * @return Generator<mixed[]>
      */
     public function steps() : Generator
     {

diff --git a/src/Classifiers/MultilayerPerceptron.php b/src/Classifiers/MultilayerPerceptron.php
@@ -69,7 +69,7 @@ class MultilayerPerceptron implements Estimator, Learner, Online, Probabilistic,
     /**
      * An array composing the user-specified hidden layers of the network in order.
      *
-     * @var \Rubix\ML\NeuralNet\Layers\Hidden[]
+     * @var Hidden[]
      */
     protected array $hiddenLayers;
 
@@ -165,7 +165,7 @@ class MultilayerPerceptron implements Estimator, Learner, Online, Probabilistic,
     protected ?array $losses = null;
 
     /**
-     * @param \Rubix\ML\NeuralNet\Layers\Hidden[] $hiddenLayers
+     * @param Hidden[] $hiddenLayers
      * @param int $batchSize
      * @param Optimizer|null $optimizer
      * @param float $l2Penalty
@@ -259,7 +259,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {
@@ -304,7 +304,7 @@ public function trained() : bool
     /**
      * Return an iterable progress table with the steps from the last training session.
      *
-     * @return \Generator<mixed[]>
+     * @return Generator<mixed[]>
      */
     public function steps() : Generator
     {

diff --git a/src/Classifiers/NaiveBayes.php b/src/Classifiers/NaiveBayes.php
@@ -151,7 +151,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {

diff --git a/src/Classifiers/OneVsRest.php b/src/Classifiers/OneVsRest.php
@@ -56,7 +56,7 @@ class OneVsRest implements Estimator, Learner, Probabilistic, Parallel, Persista
     /**
      * A map of each class to its binary classifier.
      *
-     * @var array<\Rubix\ML\Learner>
+     * @var array<Learner>
      */
     protected array $classifiers = [
         //

diff --git a/src/Classifiers/SVC.php b/src/Classifiers/SVC.php
@@ -150,7 +150,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {

diff --git a/src/Classifiers/SoftmaxClassifier.php b/src/Classifiers/SoftmaxClassifier.php
@@ -192,7 +192,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {
@@ -234,7 +234,7 @@ public function trained() : bool
     /**
      * Return an iterable progress table with the steps from the last training session.
      *
-     * @return \Generator<mixed[]>
+     * @return Generator<mixed[]>
      */
     public function steps() : Generator
     {

diff --git a/src/Clusterers/FuzzyCMeans.php b/src/Clusterers/FuzzyCMeans.php
@@ -176,7 +176,7 @@ public function type() : EstimatorType
     /**
      * Return the data types that the estimator is compatible with.
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {
@@ -225,7 +225,7 @@ public function centroids() : array
     /**
      * Return an iterable progress table with the steps from the last training session.
      *
-     * @return \Generator<mixed[]>
+     * @return Generator<mixed[]>
      */
     public function steps() : Generator
     {

diff --git a/src/Clusterers/GaussianMixture.php b/src/Clusterers/GaussianMixture.php
@@ -188,7 +188,7 @@ public function type() : EstimatorType
     /**
      * Return the data types that the estimator is compatible with.
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {
@@ -256,7 +256,7 @@ public function variances() : array
     /**
      * Return an iterable progress table with the steps from the last training session.
      *
-     * @return \Generator<mixed[]>
+     * @return Generator<mixed[]>
      */
     public function steps() : Generator
     {

diff --git a/src/Clusterers/KMeans.php b/src/Clusterers/KMeans.php
@@ -196,7 +196,7 @@ public function type() : EstimatorType
     /**
      * Return the data types that the estimator is compatible with.
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {
@@ -256,7 +256,7 @@ public function sizes() : array
     /**
      * Return an iterable progress table with the steps from the last training session.
      *
-     * @return \Generator<mixed[]>
+     * @return Generator<mixed[]>
      */
     public function steps() : Generator
     {

diff --git a/src/Clusterers/MeanShift.php b/src/Clusterers/MeanShift.php
@@ -229,7 +229,7 @@ public function type() : EstimatorType
     /**
      * Return the data types that the estimator is compatible with.
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {
@@ -278,7 +278,7 @@ public function centroids() : array
     /**
      * Return an iterable progress table with the steps from the last training session.
      *
-     * @return \Generator<mixed[]>
+     * @return Generator<mixed[]>
      */
     public function steps() : Generator
     {

diff --git a/src/CommitteeMachine.php b/src/CommitteeMachine.php
@@ -56,7 +56,7 @@ class CommitteeMachine implements Estimator, Learner, Parallel, Persistable
     /**
      * The committee of experts. i.e. the ensemble of estimators.
      *
-     * @var list<\Rubix\ML\Learner>
+     * @var list<Learner>
      */
     protected array $experts;
 
@@ -70,7 +70,7 @@ class CommitteeMachine implements Estimator, Learner, Parallel, Persistable
     /**
      * The data types that the committee is compatible with.
      *
-     * @var list<\Rubix\ML\DataType>
+     * @var list<DataType>
      */
     protected array $compatibility;
 
@@ -84,7 +84,7 @@ class CommitteeMachine implements Estimator, Learner, Parallel, Persistable
     ];
 
     /**
-     * @param \Rubix\ML\Learner[] $experts
+     * @param Learner[] $experts
      * @param (int|float)[]|null $influences
      * @throws InvalidArgumentException
      */
@@ -173,7 +173,7 @@ public function type() : EstimatorType
      *
      * @internal
      *
-     * @return list<\Rubix\ML\DataType>
+     * @return list<DataType>
      */
     public function compatibility() : array
     {
@@ -208,7 +208,7 @@ public function trained() : bool
     /**
      * Return the learner instances of the committee.
      *
-     * @return list<\Rubix\ML\Learner>
+     * @return list<Learner>
      */
     public function experts() : array
     {

diff --git a/src/CrossValidation/Metrics/Accuracy.php b/src/CrossValidation/Metrics/Accuracy.php
@@ -37,7 +37,7 @@ public function range() : Tuple
      *
      * @internal
      *
-     * @return list<\Rubix\ML\EstimatorType>
+     * @return list<EstimatorType>
      */
     public function compatibility() : array
     {

diff --git a/src/CrossValidation/Metrics/Completeness.php b/src/CrossValidation/Metrics/Completeness.php
@@ -42,7 +42,7 @@ public function range() : Tuple
      *
      * @internal
      *
-     * @return list<\Rubix\ML\EstimatorType>
+     * @return list<EstimatorType>
      */
     public function compatibility() : array
     {

diff --git a/src/CrossValidation/Metrics/FBeta.php b/src/CrossValidation/Metrics/FBeta.php
@@ -92,7 +92,7 @@ public function range() : Tuple
      *
      * @internal
      *
-     * @return list<\Rubix\ML\EstimatorType>
+     * @return list<EstimatorType>
      */
     public function compatibility() : array
     {