analytics/classes/packable.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  * Exportable machine learning backend interface.
  19  *
  20  * @package   core_analytics
  21  * @copyright 2019 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 core_analytics;
  26
  27 defined('MOODLE_INTERNAL') || die();
  28
  29 /**
  30  * Exportable machine learning backend interface.
  31  *
  32  * @package   core_analytics
  33  * @copyright 2019 David Monllao {@link http://www.davidmonllao.com}
  34  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35  */
  36 interface packable {
  37
  38     /**
  39      * Exports the machine learning model.
  40      *
  41      * @throws \moodle_exception
  42      * @param  string $uniqueid  The model unique id
  43      * @param  string $modeldir  The directory that contains the trained model.
  44      * @return string            The path to the directory that contains the exported model.
  45      */
  46     public function export(string $uniqueid, string $modeldir) : string;
  47
  48     /**
  49      * Imports the provided machine learning model.
  50      *
  51      * @param  string $uniqueid The model unique id
  52      * @param  string $modeldir  The directory that will contain the trained model.
  53      * @param  string $importdir The directory that contains the files to import.
  54      * @return bool Success
  55      */
  56     public function import(string $uniqueid, string $modeldir, string $importdir) : bool;
  57 }