Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/analytics/classes/ -> predictor.php (source)

[Source view]

Predictions processor interface.

Copyright: 2017 David Monllao {@link http://www.davidmonllao.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 78 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

predictor:: (3 methods):
  is_ready()
  clear_model()
  delete_output_dir()


Interface: predictor  - X-Ref

Predictors interface.

is_ready()   X-Ref
Is it ready to predict?

return: bool

clear_model($uniqueid, $modelversionoutputdir)   X-Ref
Delete all stored information of the current model id.

This method is called when there are important changes to a model,
all previous training algorithms using that version of the model
should be deleted.

In case you want to perform extra security measures before deleting
a directory you can check that $modelversionoutputdir subdirectories
can only be named 'execution', 'evaluation' or 'testing'.

param: string $uniqueid The site model unique id string
param: string $modelversionoutputdir The output dir of this model version
return: null

delete_output_dir($modeloutputdir, $uniqueid)   X-Ref
Delete the output directory.

This method is called when a model is completely deleted.

In case you want to perform extra security measures before deleting
a directory you can check that the subdirectories are timestamps
(the model version) and each of this subdirectories' subdirectories
can only be named 'execution', 'evaluation' or 'testing'.

param: string $modeloutputdir The model directory id (parent of all model versions subdirectories).
param: string $uniqueid
return: null