See Release Notes
Long Term Support Release
<?php // This file is part of Moodle - http://moodle.org/ // // Moodle is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Moodle is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Moodle. If not, see <http://www.gnu.org/licenses/>. /** * Evaluates the provided model. * * @package tool_analytics * @copyright 2016 David Monllao {@link http://www.davidmonllao.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ define('CLI_SCRIPT', true); require_once(__DIR__ . '/../../../../config.php'); require_once($CFG->libdir.'/clilib.php'); $help = "Evaluates the provided model. Options: --modelid Model id --list List models --non-interactive Not interactive questions --analysisinterval Restrict the evaluation to 1 single analysis interval (Optional) --mode 'configuration' or 'trainedmodel'. You can only use mode=trainedmodel when the trained" . " model was imported" . " --reuse-prev-analysed Reuse recently analysed courses instead of analysing the whole site. Set it to false while" . " coding indicators. Defaults to true (Optional)" . " -h, --help Print out this help Example: \$ php admin/tool/analytics/cli/evaluate_model.php --modelid=1 --analysisinterval='\\core\\analytics\\time_splitting\\quarters' "; // Now get cli options. list($options, $unrecognized) = cli_get_params( array( 'help' => false, 'modelid' => false, 'list' => false, 'analysisinterval' => false, 'mode' => 'configuration', 'reuse-prev-analysed' => true, 'non-interactive' => false, ), array( 'h' => 'help', ) ); if ($options['help']) { echo $help; exit(0); } if (!\core_analytics\manager::is_analytics_enabled()) { echo get_string('analyticsdisabled', 'analytics') . PHP_EOL; exit(0); } if ($options['list']) { \tool_analytics\clihelper::list_models(); exit(0); } if ($options['modelid'] === false) { // All actions but --list require a modelid. echo $help; exit(0); } if ($options['mode'] !== 'configuration' && $options['mode'] !== 'trainedmodel') { cli_error('Error: The provided mode is not supported'); } if ($options['mode'] == 'trainedmodel' && $options['analysisinterval']) { cli_error('Sorry, no analysis interval can be specified when using \'trainedmodel\' mode.'); } // We need admin permissions. \core\session\manager::set_user(get_admin()); $model = new \core_analytics\model($options['modelid']); mtrace(get_string('analysingsitedata', 'tool_analytics')); if ($options['reuse-prev-analysed']) { mtrace(get_string('evaluationinbatches', 'tool_analytics')); } $renderer = $PAGE->get_renderer('tool_analytics'); $analyseroptions = array( 'timesplitting' => $options['analysisinterval'], 'reuseprevanalysed' => $options['reuse-prev-analysed'], 'mode' => $options['mode'], ); // Evaluate its suitability to predict accurately. $results = $model->evaluate($analyseroptions); // Reset the page as some indicators may call external functions that overwrite the page context. \tool_analytics\output\helper::reset_page(); echo $renderer->render_evaluate_results($results, $model->get_analyser()->get_logs()); // Check that we have, at leasa,t 1 valid dataset (not necessarily good) to use. foreach ($results as $result) { if ($result->status !== \core_analytics\model::NO_DATASET && $result->status !== \core_analytics\model::GENERAL_ERROR) { $validdatasets = true; } } if (!empty($validdatasets) && !$model->is_enabled() && $options['non-interactive'] === false) { // Select a dataset, train and enable the model. $input = cli_input(get_string('clienablemodel', 'tool_analytics')); while (!\core_analytics\manager::is_valid($input, '\core_analytics\local\time_splitting\base') && $input !== 'none') { mtrace(get_string('errorunexistingtimesplitting', 'analytics')); $input = cli_input(get_string('clienablemodel', 'tool_analytics')); } if ($input === 'none') { exit(0); } // Refresh the instance to prevent unexpected issues.< $model = new \core_analytics\model($modelobj);> $model = new \core_analytics\model($options['modelid']);// Set the time splitting method file and enable it. $model->enable($input); mtrace(get_string('trainandpredictmodel', 'tool_analytics')); // Train the model with the selected time splitting method and start predicting. $model->train(); $model->predict(); } exit(0);