Skip to main content

PyPI - Python Version License Unit tests Static analysis codecov

FOSSA Status Documentation Status Black

TrueLearn

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.

Metadata

Release files for truelearn 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for truelearn 1.1.0
File Size Uploaded
truelearn-1.1.0.tar.gz 41.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for truelearn 1.1.0
File Interpreter ABI Platform
truelearn-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 104.6 kB

Release files / truelearn-1.1.0.tar.gz

Download URL truelearn-1.1.0.tar.gz
Size 41.4 kB
Tags Source
SHA-256 checksum
How to use checksums
6cb3346ff2f1ca7a2ca1c76fe4b1d02347d83a604902399a8cc85e3b903309f3
BLAKE2b-256 checksum
How to use checksums
1110ccb66dc00f20ad8829661b103870c56e2325496f09569330148068df8178
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.4

Release files / truelearn-1.1.0-py3-none-any.whl

Download URL truelearn-1.1.0-py3-none-any.whl
Size 63.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3ee42f80b2d29550ba520ebfdb78ceaf4fda9f32e54e8ed6525e58371b859911
BLAKE2b-256 checksum
How to use checksums
97eda383a58588db3e1cb81078dbb20ae9839ea38b4a1e36f737af0ddd3412ac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.4

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page