Added command to generate a report about the model

Author: mikoweb

src/Module/ML/Application/Model/SpamModelReport.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace App\Module\ML\Application\Model;
+
+use App\Core\Application\Path\AppPathResolver;
+use Rubix\ML\CrossValidation\Reports\AggregateReport;
+use Rubix\ML\CrossValidation\Reports\ConfusionMatrix;
+use Rubix\ML\CrossValidation\Reports\MulticlassBreakdown;
+use Rubix\ML\Datasets\Labeled;
+use Rubix\ML\Extractors\CSV;
+use Rubix\ML\PersistentModel;
+use Rubix\ML\Persisters\Filesystem;
+use Rubix\ML\Report;
+
+/**
+ * @see https://docs.rubixml.com/latest/cross-validation.html
+ * @see https://docs.rubixml.com/latest/cross-validation/reports/multiclass-breakdown.html
+ * @see https://docs.rubixml.com/latest/cross-validation/reports/confusion-matrix.html
+ */
+readonly class SpamModelReport
+{
+    public function __construct(
+        private AppPathResolver $appPathResolver,
+    ) {
+    }
+
+    public function generateReport(
+        string $testingDatasetFilename,
+        string $modelFilename,
+    ): Report {
+        $dataset = Labeled::fromIterator(new CSV(
+            $this->appPathResolver->getDatasetPath($testingDatasetFilename),
+            header: true,
+        ));
+
+        $estimator = PersistentModel::load(new Filesystem(
+            $this->appPathResolver->getModelPath($modelFilename)
+        ));
+
+        $predictions = $estimator->predict($dataset);
+
+        $report = new AggregateReport([
+            new MulticlassBreakdown(),
+            new ConfusionMatrix(),
+        ]);
+
+        return $report->generate($predictions, $dataset->labels());
+    }
+}

src/Module/ML/UI/CLI/MlReportCommand.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Module\ML\UI\CLI;
+
+use App\Module\ML\Application\Model\SpamModelReport;
+use App\Module\ML\Domain\Constant;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+#[AsCommand(
+    name: 'app:ml:report',
+    description: 'Command to generate a report about the model.',
+)]
+class MlReportCommand extends Command
+{
+    public function __construct(
+        private readonly SpamModelReport $spamModelReport,
+    ) {
+        parent::__construct();
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        $io->info('Generating report...');
+
+        $io->writeln($this->spamModelReport->generateReport(
+            Constant::DEFAULT_SPAM_TESTING_DATASET_FILENAME,
+            Constant::SPAM_MODEL_FILENAME,
+        )->toJSON());
+
+        $io->success('The report has been generated!');
+
+        return Command::SUCCESS;
+    }
+}