MDL-65175 analytics: Rm references to unexisting time-splittings
[moodle.git] / analytics / upgrade.txt
1 This files describes API changes in analytics sub system,
2 information provided here is intended especially for developers.
4 === 3.7 ===
6 * \core_analytics\regressor::evaluate_regression and \core_analytics\classifier::evaluate_classification
7   have been updated to include a new $trainedmodeldir param. This new param will be used to evaluate the
8   existing trained model.
9 * Plugins and core subsystems can now declare default prediction models by describing them in
10   their db/analytics.php file. Models should not be created manually via the db/install.php
11   file any more.
12 * The method \core_analytics\manager::add_builtin_models() has been deprecated. The functionality
13   has been replaced with automatic update of models provided by the core moodle component. There
14   is no need to call this method explicitly any more. Instead, adding new models can be achieved
15   by updating the lib/db/analytics.php file and bumping the core version.
16 * \core_analytics\model::execute_prediction_callbacks now returns an array with both sample's contexts
17   and the prediction records.
18 * Time splitting methods:
19     * \core_analytics\local\time_splitting\base::append_rangeindex and
20       \core_analytics\local\time_splitting\base::infer_sample_info are now marked as final and can not
21       be overwritten.
22     * Can now overwrite include_range_info_in_training_data() and
23       get_training_ranges() methods. They can be used to create time splitting methods with a pre-defined
24       number of ranges.
25     * Can now overwrite cache_indicator_calculations(). You should return false if the time frames generated
26       by your time-splitting method are unique and / or can hardly be reused by further models.
27     * \core_analytics\local\analyser\base::get_most_recent_prediction_range has been moved to
28       \core_analytics\local\time_splitting\base::get_most_recent_prediction_range and it is not overwritable
29       by time splitting methods.
30 * Targets:
31     * The visibility of the following methods must now be public: ignored_predicted_classes()
32       and get_insights_users()
33     * Prediction_actions() has now a 3rd parameter $isinsightuser. This parameter is true
34       when we are listing actions for the user that will receives the insight.
35     * Can now implement a always_update_analysis_time() method so analysable elements' timeanalysed is
36       only updated when analysable elements have been successfully evaluated. It is useful for lightweight targets.
37     * Can not implement two new methods to tune the insights generated by the model: get_insight_subject()
38       and get_insight_context_url().
39 * Analysers:
40     * The visibility of get_all_samples() method must now be public.
41     * get_analysables() method has been deprecated in favour of a new get_analysables_interator()
42       for performance reasons.
43     * Can overwrite a new one_sample_per_analysable() method if the analysables they use only have
44       one sample. The insights generated by models will then include the suggested actions in
45       the notification.
47 === 3.5 ===
49 * There are two new methods for analysers, processes_user_data() and join_sample_user(). You
50   need to overwrite them if your analyser uses user data. As a general statement, you should
51   overwrite these new methods if your samples return 'user' data. These new methods are used
52   for analytics' privacy API implementation.