|PyPi| |License| |Unit tests| |Static analysis| |codecov|
|FOSSA Status| |docs| |Black|
.. image:: https://raw.githubusercontent.com/truelearnai/truelearn/main/docs/images/TrueLearn_logo.svg
:target: https://truelearnai.github.io/
:alt: TrueLearn
:width: 800
:height: 160
:align: center
|
**TrueLearn** is a machine learning library for predicting and modelling learner engagement with educational resources.
.. |PyPi| image:: https://img.shields.io/pypi/pyversions/truelearn?label=Python&style=flat
:target: https://pypi.org/project/truelearn/
:alt: PyPI - Python Version
.. |License| image:: https://img.shields.io/badge/License-MIT-blue
:target: https://github.com/TrueLearnAI/truelearn/blob/main/LICENSE
:alt: License
.. |Unit tests| image:: https://github.com/TrueLearnAI/truelearn/actions/workflows/unit_tests.yml/badge.svg
:target: https://github.com/TrueLearnAI/truelearn/actions/workflows/unit_tests.yml
:alt: Unit tests
.. |Static analysis| image:: https://github.com/TrueLearnAI/truelearn/actions/workflows/static_analysis.yml/badge.svg
:target: https://github.com/TrueLearnAI/truelearn/actions/workflows/static_analysis.yml
:alt: Static analysis
.. |codecov| image:: https://codecov.io/gh/TrueLearnAI/truelearn/branch/main/graph/badge.svg?token=69JZ051NAO
:target: https://codecov.io/gh/TrueLearnAI/truelearn
:alt: codecov
.. |FOSSA Status| image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2FTrueLearnAI%2Ftruelearn.svg?type=small
:target: https://app.fossa.com/projects/git%2Bgithub.com%2FTrueLearnAI%2Ftruelearn?ref=badge_small
:alt: FOSSA Status
.. |docs| image:: https://readthedocs.org/projects/truelearn/badge/?version=latest
:target: https://truelearn.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Black
User Installation
#################
**Install from PyPI:** ::
pip install -U truelearn
For more information on installation, see the `Getting Started guide <https://truelearn.readthedocs.io/en/stable/tutorial/quickstart.html>`_.
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 <https://truelearn.readthedocs.io/en/stable/index.html#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 <https://truelearn.readthedocs.io/en/latest/dev/index.html>`_ 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 <https://truelearn.readthedocs.io/en/latest/dev/get_started.html>`_
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 <https://truelearn.readthedocs.io/en/latest/dev/testing.html>`_
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 <https://truelearn.readthedocs.io/en/latest/dev/before_pr.html>`_.
Raw data
{
"_id": null,
"home_page": "",
"name": "truelearn",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "machine learning,python,statistics,probability",
"author": "Sahanbull, KD-7, yuxqiu, deniselezi, aaneelshalman",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/11/10/ccb66dc00f20ad8829661b103870c56e2325496f09569330148068df8178/truelearn-1.1.0.tar.gz",
"platform": null,
"description": "|PyPi| |License| |Unit tests| |Static analysis| |codecov|\n\n|FOSSA Status| |docs| |Black|\n\n\n.. image:: https://raw.githubusercontent.com/truelearnai/truelearn/main/docs/images/TrueLearn_logo.svg\n :target: https://truelearnai.github.io/\n :alt: TrueLearn\n :width: 800\n :height: 160\n :align: center\n\n|\n\n**TrueLearn** is a machine learning library for predicting and modelling learner engagement with educational resources.\n\n.. |PyPi| image:: https://img.shields.io/pypi/pyversions/truelearn?label=Python&style=flat\n :target: https://pypi.org/project/truelearn/\n :alt: PyPI - Python Version\n\n.. |License| image:: https://img.shields.io/badge/License-MIT-blue\n :target: https://github.com/TrueLearnAI/truelearn/blob/main/LICENSE\n :alt: License\n\n.. |Unit tests| image:: https://github.com/TrueLearnAI/truelearn/actions/workflows/unit_tests.yml/badge.svg\n :target: https://github.com/TrueLearnAI/truelearn/actions/workflows/unit_tests.yml\n :alt: Unit tests\n\n.. |Static analysis| image:: https://github.com/TrueLearnAI/truelearn/actions/workflows/static_analysis.yml/badge.svg\n :target: https://github.com/TrueLearnAI/truelearn/actions/workflows/static_analysis.yml\n :alt: Static analysis\n\n.. |codecov| image:: https://codecov.io/gh/TrueLearnAI/truelearn/branch/main/graph/badge.svg?token=69JZ051NAO\n :target: https://codecov.io/gh/TrueLearnAI/truelearn\n :alt: codecov\n\n.. |FOSSA Status| image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2FTrueLearnAI%2Ftruelearn.svg?type=small\n :target: https://app.fossa.com/projects/git%2Bgithub.com%2FTrueLearnAI%2Ftruelearn?ref=badge_small\n :alt: FOSSA Status\n\n.. |docs| image:: https://readthedocs.org/projects/truelearn/badge/?version=latest\n :target: https://truelearn.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Black\n\n\nUser Installation\n#################\n\n**Install from PyPI:** ::\n\n pip install -U truelearn\n\nFor more information on installation, see the `Getting Started guide <https://truelearn.readthedocs.io/en/stable/tutorial/quickstart.html>`_.\n\nDocumentation\n#############\n\n**Latest stable release** is available at: https://truelearn.readthedocs.io/en/stable/\n\n**Development version** is available at: https://truelearn.readthedocs.io/en/latest/\n\nChange Log\n##########\n\nSee the `Change Log <https://truelearn.readthedocs.io/en/stable/index.html#change-log>`_\nfor a history of all the major changes to the truelearn.\n\nAlternatively you can find it in the ``CHANGELOG.rst`` file found here:\nhttps://github.com/TrueLearnAI/truelearn/blob/main/docs/changelog.rst\n\nContributing\n############\n\nContributions are welcome, and they are greatly appreciated! Every little bit helps,\nand credit will always be given.\nPlease see: `Contributing Guide <https://truelearn.readthedocs.io/en/latest/dev/index.html>`_ for more information!\nWe have listed a brief guide below.\n\n\nSource Code\n-----------\n\nYou can check out the latest the source code with the following command::\n\n git clone https://github.com/TrueLearnAI/truelearn.git\n\n\nInstalling TrueLearn from source\n--------------------------------\n\nAfter cloning the repository, you can install TrueLearn locally from source::\n\n pip install -e .[dev]\n\n # if you are using zsh\n pip install -e \".[dev]\"\n\nSee the `Contributing Guide: Getting Started <https://truelearn.readthedocs.io/en/latest/dev/get_started.html>`_\nfor a more detailed explanation.\n\n\nTesting\n-------\n\nAfter installation, you can run the tests from the source directory::\n\n pytest truelearn\n\nSee the `Contributing Guide: Testing guide <https://truelearn.readthedocs.io/en/latest/dev/testing.html>`_\nfor a more detailed explanation.\n\n\nBefore submitting a PR\n----------------------\n\nPlease make sure you have followed the Guidelines outlined in the\n`Contributing Guide: Before/During PR <https://truelearn.readthedocs.io/en/latest/dev/before_pr.html>`_.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A Machine learning library that models and predicts learner engagement",
"version": "1.1.0",
"project_urls": {
"Documentation": "https://truelearn.readthedocs.io/en/stable/",
"Homepage": "https://truelearnai.github.io/",
"Issues": "https://github.com/TrueLearnAI/truelearn/issues",
"Source": "https://github.com/TrueLearnAI/truelearn"
},
"split_keywords": [
"machine learning",
"python",
"statistics",
"probability"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "97eda383a58588db3e1cb81078dbb20ae9839ea38b4a1e36f737af0ddd3412ac",
"md5": "a593667a638d0286c5f866915dae2361",
"sha256": "3ee42f80b2d29550ba520ebfdb78ceaf4fda9f32e54e8ed6525e58371b859911"
},
"downloads": -1,
"filename": "truelearn-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a593667a638d0286c5f866915dae2361",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 63197,
"upload_time": "2023-08-13T17:30:06",
"upload_time_iso_8601": "2023-08-13T17:30:06.722350Z",
"url": "https://files.pythonhosted.org/packages/97/ed/a383a58588db3e1cb81078dbb20ae9839ea38b4a1e36f737af0ddd3412ac/truelearn-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1110ccb66dc00f20ad8829661b103870c56e2325496f09569330148068df8178",
"md5": "f89952dbd5aee419c60f51610eaa1c2d",
"sha256": "6cb3346ff2f1ca7a2ca1c76fe4b1d02347d83a604902399a8cc85e3b903309f3"
},
"downloads": -1,
"filename": "truelearn-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f89952dbd5aee419c60f51610eaa1c2d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 41355,
"upload_time": "2023-08-13T17:30:08",
"upload_time_iso_8601": "2023-08-13T17:30:08.343651Z",
"url": "https://files.pythonhosted.org/packages/11/10/ccb66dc00f20ad8829661b103870c56e2325496f09569330148068df8178/truelearn-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-13 17:30:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TrueLearnAI",
"github_project": "truelearn",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "truelearn"
}
JSON
