lib/mlbackend/python/classes/processor.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * Python predictions processor
  19  *
  20  * @package   mlbackend_python
  21  * @copyright 2016 David Monllao {@link http://www.davidmonllao.com}
  22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 namespace mlbackend_python;
  26
  27 defined('MOODLE_INTERNAL') || die();
  28
  29 /**
  30  * Python predictions processor.
  31  *
  32  * @package   mlbackend_python
  33  * @copyright 2016 David Monllao {@link http://www.davidmonllao.com}
  34  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35  */
  36 class processor implements \core_analytics\predictor {
  37
  38     /**
  39      * The required version of the python package that performs all calculations.
  40      */
  41     const REQUIRED_PIP_PACKAGE_VERSION = '0.0.9';
  42
  43     /**
  44      * Is the plugin ready to be used?.
  45      *
  46      * @return bool
  47      */
  48     public function is_ready() {
  49
  50         // Check the installed pip package version.
  51         $cmd = 'python -m moodleinspire.version';
  52
  53         $output = null;
  54         $exitcode = null;
  55         // Execute it sending the standard error to $output.
  56         $result = exec($cmd . ' 2>&1', $output, $exitcode);
  57
  58         if ($result === self::REQUIRED_PIP_PACKAGE_VERSION) {
  59             return true;
  60         }
  61
  62         if ($exitcode != 0) {
  63             return get_string('pythonpackagenotinstalled', 'mlbackend_python', $cmd);
  64         }
  65
  66         if ($result) {
  67             $a = (object)array('installed' => $result, 'required' => self::REQUIRED_PIP_PACKAGE_VERSION);
  68             return get_string('packageinstalledshouldbe', 'mlbackend_python', $a);
  69         }
  70
  71         return get_string('pythonpackagenotinstalled', 'mlbackend_python', $cmd);
  72     }
  73
  74     /**
  75      * Trains a machine learning algorithm with the provided dataset.
  76      *
  77      * @param string $uniqueid
  78      * @param \stored_file $dataset
  79      * @param string $outputdir
  80      * @return \stdClass
  81      */
  82     public function train($uniqueid, \stored_file $dataset, $outputdir) {
  83
  84         // Obtain the physical route to the file.
  85         $datasetpath = $this->get_file_path($dataset);
  86
  87         $cmd = 'python -m moodleinspire.training ' .
  88             escapeshellarg($uniqueid) . ' ' .
  89             escapeshellarg($outputdir) . ' ' .
  90             escapeshellarg($datasetpath);
  91
  92         if (!PHPUNIT_TEST && CLI_SCRIPT) {
  93             debugging($cmd, DEBUG_DEVELOPER);
  94         }
  95
  96         $output = null;
  97         $exitcode = null;
  98         $result = exec($cmd, $output, $exitcode);
  99
 100         if (!$result) {
 101             throw new \moodle_exception('errornopredictresults', 'analytics');
 102         }
 103
 104         if (!$resultobj = json_decode($result)) {
 105             throw new \moodle_exception('errorpredictwrongformat', 'analytics', '', json_last_error_msg());
 106         }
 107
 108         if ($exitcode != 0) {
 109             throw new \moodle_exception('errorpredictionsprocessor', 'analytics', '', implode(', ', $resultobj->errors));
 110         }
 111
 112         return $resultobj;
 113     }
 114
 115     /**
 116      * Returns predictions for the provided dataset samples.
 117      *
 118      * @param string $uniqueid
 119      * @param \stored_file $dataset
 120      * @param string $outputdir
 121      * @return \stdClass
 122      */
 123     public function predict($uniqueid, \stored_file $dataset, $outputdir) {
 124
 125         // Obtain the physical route to the file.
 126         $datasetpath = $this->get_file_path($dataset);
 127
 128         $cmd = 'python -m moodleinspire.prediction ' .
 129             escapeshellarg($uniqueid) . ' ' .
 130             escapeshellarg($outputdir) . ' ' .
 131             escapeshellarg($datasetpath);
 132
 133         if (!PHPUNIT_TEST && CLI_SCRIPT) {
 134             debugging($cmd, DEBUG_DEVELOPER);
 135         }
 136
 137         $output = null;
 138         $exitcode = null;
 139         $result = exec($cmd, $output, $exitcode);
 140
 141         if (!$result) {
 142             throw new \moodle_exception('errornopredictresults', 'analytics');
 143         }
 144
 145         if (!$resultobj = json_decode($result)) {
 146             throw new \moodle_exception('errorpredictwrongformat', 'analytics', '', json_last_error_msg());
 147         }
 148
 149         if ($exitcode != 0) {
 150             throw new \moodle_exception('errorpredictionsprocessor', 'analytics', '', implode(', ', $resultobj->errors));
 151         }
 152
 153         return $resultobj;
 154     }
 155
 156     /**
 157      * Evaluates the provided dataset.
 158      *
 159      * @param string $uniqueid
 160      * @param float $maxdeviation
 161      * @param int $niterations
 162      * @param \stored_file $dataset
 163      * @param string $outputdir
 164      * @return \stdClass
 165      */
 166     public function evaluate($uniqueid, $maxdeviation, $niterations, \stored_file $dataset, $outputdir) {
 167
 168         // Obtain the physical route to the file.
 169         $datasetpath = $this->get_file_path($dataset);
 170
 171         $cmd = 'python -m moodleinspire.evaluation ' .
 172             escapeshellarg($uniqueid) . ' ' .
 173             escapeshellarg($outputdir) . ' ' .
 174             escapeshellarg($datasetpath) . ' ' .
 175             escapeshellarg(\core_analytics\model::MIN_SCORE) . ' ' .
 176             escapeshellarg($maxdeviation) . ' ' .
 177             escapeshellarg($niterations);
 178
 179         if (!PHPUNIT_TEST && CLI_SCRIPT) {
 180             debugging($cmd, DEBUG_DEVELOPER);
 181         }
 182
 183         $output = null;
 184         $exitcode = null;
 185         $result = exec($cmd, $output, $exitcode);
 186
 187         if (!$result) {
 188             throw new \moodle_exception('errornopredictresults', 'analytics');
 189         }
 190
 191         if (!$resultobj = json_decode($result)) {
 192             throw new \moodle_exception('errorpredictwrongformat', 'analytics', '', json_last_error_msg());
 193         }
 194
 195         return $resultobj;
 196     }
 197
 198     /**
 199      * Returns the path to the dataset file.
 200      *
 201      * @param \stored_file $file
 202      * @return string
 203      */
 204     protected function get_file_path(\stored_file $file) {
 205         // From moodle filesystem to the local file system.
 206         // This is not ideal, but there is no read access to moodle filesystem files.
 207         return $file->copy_content_to_temp('core_analytics');
 208     }
 209 }