Add an integration test & Update docs (#5)

Author: mhdcodes

.github/workflows/cron.yml

@@ -17,14 +17,11 @@ jobs:
     name: PHP${{ matrix.php }} - ${{ matrix.stability }} - ${{ matrix.os }}
 
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
           extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap
 
       - name: Install package
-        run: composer require phpjuice/opencf
+        run: composer global require phpjuice/opencf

README.md

@@ -43,29 +43,28 @@ Adding a dataset to the recommender can be done using the constructor or can be
 users ratings via the `setDataset()` method:
 
 ```php
-
-$dataset =[
-  [
-    "squid" => 1,
-    "cuttlefish" => 0.5,
-    "octopus" => 0.2
-  ],
-  [
-    "squid" => 1,
-    "octopus" => 0.5,
-    "nautilus" => 0.2
-  ],
-  [
-    "squid" => 0.2,
-    "octopus" => 1,
-    "cuttlefish" => 0.4,
-    "nautilus" => 0.4
-  ],
-  [
-    "cuttlefish" => 0.9,
-    "octopus" => 0.4,
-    "nautilus" => 0.5
-  ]
+$dataset = [
+    "squid" => [
+        "user1" => 1,
+        "user2" => 1,
+        "user3" => 0.2,
+    ],
+    "cuttlefish" => [
+        "user1" => 0.5,
+        "user3" => 0.4,
+        "user4" => 0.9,
+    ],
+    "octopus" => [
+        "user1" => 0.2,
+        "user2" => 0.5,
+        "user3" => 1,
+        "user4" => 0.4,
+    ],
+    "nautilus" => [
+        "user2" => 0.2,
+        "user3" => 0.4,
+        "user4" => 0.5,
+    ],
 ];
 
 $recommenderService->setDataset($dataset);
@@ -95,7 +94,7 @@ This should produce the following results when using `WeightedSlopeone` recommen
 ```php
 [
   "cuttlefish" => 0.25,
-  "octopus" => 0.23333333333333,
+  "octopus" => 0.23,
   "nautilus" => 0.1
 ];
 ```

src/Algorithms/Recommender.php

@@ -8,41 +8,29 @@
 use OpenCF\Contracts\IRecommender;
 use OpenCF\Contracts\ISimilarity;
 use OpenCF\Contracts\IVector;
+use OpenCF\Exceptions\EmptyDatasetException;
+use OpenCF\Exceptions\EmptyModelException;
 use OpenCF\Support\Vector;
 
 abstract class Recommender implements IRecommender
 {
-    /**
-     * training set.
-     *
-     * @var array[][]
-     */
+    /** @var array */
     protected array $dataset;
 
-    /**
-     * model.
-     *
-     * @var array[][]
-     */
+    /** @var array|null */
     protected ?array $model;
 
     /**
-     * a measure function to calculate similarity.
-     *
      * @var ISimilarity
      */
     protected ISimilarity $similarityFunction;
 
     /**
-     * Predictor.
-     *
      * @var IPredictor
      */
     protected IPredictor $predictor;
 
     /**
-     * vector calculations provider.
-     *
      * @var IVector
      */
     protected IVector $vector;
@@ -63,6 +51,10 @@ public function __construct(
     /** @inheritdoc */
     public function buildModel(): self
     {
+        if (empty($this->dataset)) {
+            throw new EmptyDatasetException();
+        }
+
         foreach ($this->dataset as $k1 => $r1) {
             foreach ($this->dataset as $k2 => $r2) {
                 // if we are comparing the item
@@ -92,8 +84,12 @@ public function buildModel(): self
     /** @inheritdoc */
     public function predict(array $userRatings): array
     {
+        if (empty($this->model)) {
+            throw new EmptyModelException();
+        }
+
         $predictions = [];
-        foreach ($this->model ?? [] as $key => $items) {
+        foreach ($this->model as $key => $items) {
             // if the rating is present in the
             // evaluation given by the user we skip
             if (isset($userRatings[$key])) {

src/Algorithms/Slopeone/WeightedSlopeone.php

@@ -6,9 +6,7 @@
 
 class WeightedSlopeone extends Recommender
 {
-    /**
-     * @inheritdoc
-     */
+    /** @inheritdoc */
     public function name(): string
     {
         return 'WeightedSlopeone';

src/Exceptions/EmptyModelException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace OpenCF\Exceptions;
+
+use InvalidArgumentException;
+
+class EmptyModelException extends InvalidArgumentException
+{
+}

tests/Algorithms/Slopeone/WeightedSlopeoneTest.php

@@ -79,9 +79,9 @@
         'Hulk' => 2,
     ];
     $expected = [
-        'Batman V Superman' => 2,
+        'Batman V Superman' => 2.0,
     ];
-    expect($scheme->predict($user1))->toEqual($expected);
+    expect($scheme->predict($user1))->toBe($expected);
 
     $user2 = [
         'Batman V Superman' => 2,
@@ -92,7 +92,7 @@
     $expected = [
         'Avatar' => 2.13,
     ];
-    expect($scheme->predict($user2))->toEqual($expected);
+    expect($scheme->predict($user2))->toBe($expected);
 
     $user3 = [
         'Batman V Superman' => 5,
@@ -103,7 +103,7 @@
     $expected = [
         'Iron Man' => 3.88,
     ];
-    expect($scheme->predict($user3))->toEqual($expected);
+    expect($scheme->predict($user3))->toBe($expected);
 
     $user4 = [
         'Batman V Superman' => 5,
@@ -112,9 +112,9 @@
         'Hulk' => 4,
     ];
     $expected = [
-        'Spider man' => 4,
+        'Spider man' => 4.0,
     ];
-    expect($scheme->predict($user4))->toEqual($expected);
+    expect($scheme->predict($user4))->toBe($expected);
 
     $user5 = [
         'Batman V Superman' => 5,
@@ -125,7 +125,7 @@
     $expected = [
         'Hulk' => 3.75,
     ];
-    expect($scheme->predict($user5))->toEqual($expected);
+    expect($scheme->predict($user5))->toBe($expected);
 
     $user6 = [
         'Avatar' => 4,
@@ -136,7 +136,7 @@
     $expected = [
         'Batman V Superman' => 4.25,
     ];
-    expect($scheme->predict($user6))->toEqual($expected);
+    expect($scheme->predict($user6))->toBe($expected);
 
     $user7 = [
         'Batman V Superman' => 1,
@@ -147,7 +147,7 @@
     $expected = [
         'Avatar' => 2.88,
     ];
-    expect($scheme->predict($user7))->toEqual($expected);
+    expect($scheme->predict($user7))->toBe($expected);
 
     $user8 = [
         'Batman V Superman' => 3,
@@ -158,7 +158,7 @@
     $expected = [
         'Iron Man' => 2.13,
     ];
-    expect($scheme->predict($user8))->toEqual($expected);
+    expect($scheme->predict($user8))->toBe($expected);
 
     $user8 = [
         'Batman V Superman' => 2,
@@ -169,7 +169,7 @@
     $expected = [
         'Spider man' => 2.75,
     ];
-    expect($scheme->predict($user8))->toEqual($expected);
+    expect($scheme->predict($user8))->toBe($expected);
 
     $user10 = [
         'Batman V Superman' => 4,
@@ -180,5 +180,5 @@
     $expected = [
         'Hulk' => 3.25,
     ];
-    expect($scheme->predict($user10))->toEqual($expected);
+    expect($scheme->predict($user10))->toBe($expected);
 });

tests/IntegrationTest.php

@@ -0,0 +1,46 @@
+<?php
+
+use OpenCF\RecommenderService;
+
+it('tests predictions with real data', function () {
+    $dataset = transpose([
+        "user1" => [
+            "squid" => 1,
+            "cuttlefish" => 0.5,
+            "octopus" => 0.2
+        ],
+        "user2" => [
+            "squid" => 1,
+            "octopus" => 0.5,
+            "nautilus" => 0.2
+        ],
+        "user3" => [
+            "squid" => 0.2,
+            "octopus" => 1,
+            "cuttlefish" => 0.4,
+            "nautilus" => 0.4
+        ],
+        "user4" => [
+            "cuttlefish" => 0.9,
+            "octopus" => 0.4,
+            "nautilus" => 0.5
+        ]
+    ]);
+
+    // Create an instance
+    $recommenderService = new RecommenderService($dataset);
+
+    // Get a recommender
+    $recommender = $recommenderService->weightedSlopeone();
+
+    // Predict future ratings
+    $results = $recommender->predict([
+        'squid' => 0.4
+    ]);
+
+    expect($results)->toBe([
+        "cuttlefish" => 0.25,
+        "octopus" => 0.23,
+        "nautilus" => 0.1
+    ]);
+});

tests/Pest.php

@@ -34,3 +34,15 @@
 | global functions to help you to reduce the number of lines of code in your test files.
 |
 */
+function transpose(array $dataset): array
+{
+    $transposed = [];
+
+    foreach ($dataset as $item => $ratings) {
+        foreach ($ratings as $key => $value) {
+            $transposed[$key][$item] = $value;
+        }
+    }
+
+    return $transposed;
+}