truelearn 1.0.0

A Machine learning library that models and predicts learner engagement

TrueLearn is a machine learning library for predicting and modelling learner engagement with educational resources.

User Installation

Install from PyPI:

pip install -U truelearn

For more information on installation, see the Getting Started guide.

Documentation

Latest stable release is available at: https://truelearn.readthedocs.io/en/stable/

Development version is available at: https://truelearn.readthedocs.io/en/latest/

Change Log

See the Change Log for a history of all the major changes to the truelearn.

Alternatively you can find it in the CHANGELOG.rst file found here: https://github.com/TrueLearnAI/truelearn/blob/main/docs/changelog.rst

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. Please see: Contributing Guide for more information! We have listed a brief guide below.

Source Code

You can check out the latest the source code with the following command:

git clone https://github.com/TrueLearnAI/truelearn.git

Installing TrueLearn from source

After cloning the repository, you can install TrueLearn locally from source:

pip install -e .[dev]

# if you are using zsh
pip install -e ".[dev]"

See the Contributing Guide: Getting Started for a more detailed explanation.

Testing

After installation, you can run the tests from the source directory:

pytest truelearn

See the Contributing Guide: Testing guide for a more detailed explanation.

Before submitting a PR

Please make sure you have followed the Guidelines outlined in the Contributing Guide: Before/During PR.