diff --git a/README.md b/README.md index 498b675..27aae9a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,20 @@ -# Let(\')s audit Learning Analytics # +# LaLA: Let(\')s audit Learning Analytics # +"Let's audit Learning Analytics" (LaLA) is a Moodle plugin to enable administrators and auditors of Moodle Learning Analytics +models to retrieve evidence for their audit, like the sample data collected on the Moodle instance, the calculated features +and predictions made by the model. -TODO Describe the plugin shortly here. +Machine learning models have often been found to be unfair, for example, when they produce more errors for certain groups[^1]. +To ensure that unfair models are not deployed in Moodle Learning Analytics (LA) and to guarantee the trustworthiness of the +deployed models, it is crucial to audit their fairness before deployment. +However, Moodle currently lacks the necessary auditability features, specifically, it does not store and make available +evidence that can be used to prove or disprove fairness claims. To address this lack of evidence, we developed a plugin +that allows developers and administrators to train and test an LA model configuration while also storing the intermediate +results and providing these data sets as downloads. By enabling fairer LA models and increasing trust in their predictions, +we hope to reach more learners and maximize the potential benefits of these models. -TODO Provide more detailed description here. +For the extensive documentation of this plugin, see the [Wiki](https://github.com/LiFaytheGoblin/moodle-tool_laaudit/wiki). + +[^1]: Riazy, S. and Simbeck, K. (2019) Predictive Algorithms in Learning Analytics and their Fairness. Gesellschaft für Informatik e.V. Available at: https://doi.org/10.18420/delfi2019_305. ## Installing via uploaded ZIP file ## @@ -42,3 +54,20 @@ 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 this program. If not, see . + +## Cite as ## +Fernsel, L. (2023) Let's audit Learning Analytics [Moodle Plugin]. Available at: https://github.com/LiFaytheGoblin/moodle-tool_laaudit/. + +```biblatex +@software{lala, + author = {Linda Fernsel}, + title={Let’s audit Learning Analytics [Moodle Plugin]}, + url={https://github.com/LiFaytheGoblin/moodle-tool_laaudit/}, + version = {1.0.0}, + date = {2023-07-26}, +} +``` + +## Acknowledgements ## +This work is funded by the Federal Ministry of Education and Research of Germany as part of the project [Fair Enough?](https://iug.htw-berlin.de/projekte/fair-enough/) +(project nr: 16DHB4002) at the University of Applied Sciences (HTW) Berlin. \ No newline at end of file diff --git a/db/install.xml b/db/install.xml index 22ee3ad..07b8557 100644 --- a/db/install.xml +++ b/db/install.xml @@ -1,5 +1,5 @@ - diff --git a/version.php b/version.php index 6e56749..e3aea88 100644 --- a/version.php +++ b/version.php @@ -25,7 +25,7 @@ defined('MOODLE_INTERNAL') || die(); $plugin->component = 'tool_laaudit'; -$plugin->release = '0.2.13'; -$plugin->version = 202306280942; -$plugin->requires = 2022112800; -$plugin->maturity = MATURITY_ALPHA; +$plugin->release = '1.0.0'; +$plugin->version = 20230726; +$plugin->requires = 2022041900; +$plugin->maturity = MATURITY_BETA;