Contents Menu Expand Light mode Dark mode Auto light/dark mode
TrueLearn 1.1.0 documentation
Logo
TrueLearn 1.1.0 documentation
  • Getting Started
  • Examples
    • BarPlotter Example
    • BubblePlotter Example
    • DotPlotter Example
    • LinePlotter Example
    • PiePlotter Example
    • RadarPlotter Example
    • RosePlotter Example
    • TreePlotter Example
    • TrueLearn Experiments
    • Wikifier Example
    • WordPlotter Example
  • API Reference
  • truelearn.base: Contains the base classes for the library
    • truelearn.base.BaseClassifier
  • truelearn.datasets: Contains utilities for using datasets
    • truelearn.datasets.PEEKKnowledgeComponentGenerator
    • truelearn.datasets.load_peek_dataset
    • truelearn.datasets.load_peek_dataset_raw
  • truelearn.learning: Contains the classifiers for learning
    • truelearn.learning.INKClassifier
    • truelearn.learning.InterestClassifier
    • truelearn.learning.KnowledgeClassifier
    • truelearn.learning.NoveltyClassifier
    • truelearn.learning.EngageClassifier
    • truelearn.learning.PersistentClassifier
    • truelearn.learning.MajorityClassifier
  • truelearn.models: Contains the representations used for learning
    • truelearn.models.BaseKnowledgeComponent
    • truelearn.models.EventModel
    • truelearn.models.LearnerModel
    • truelearn.models.LearnerMetaWeights
    • truelearn.models.KnowledgeComponent
    • truelearn.models.HistoryAwareKnowledgeComponent
    • truelearn.models.Knowledge
  • truelearn.preprocessing: Contains preprocessing functions and classes
    • truelearn.preprocessing.Wikifier
    • truelearn.preprocessing.get_values_mean
    • truelearn.preprocessing.get_values_sample_std
    • truelearn.preprocessing.get_values_population_std
  • truelearn.utils.metrics: Contains functions to generate metrics
    • truelearn.utils.metrics.get_precision_score
    • truelearn.utils.metrics.get_recall_score
    • truelearn.utils.metrics.get_accuracy_score
    • truelearn.utils.metrics.get_f1_score
  • truelearn.utils.visualisations: Contains plotting functions and classes
    • truelearn.utils.visualisations.LinePlotter
    • truelearn.utils.visualisations.PiePlotter
    • truelearn.utils.visualisations.RosePlotter
    • truelearn.utils.visualisations.BarPlotter
    • truelearn.utils.visualisations.DotPlotter
    • truelearn.utils.visualisations.BubblePlotter
    • truelearn.utils.visualisations.WordPlotter
    • truelearn.utils.visualisations.RadarPlotter
    • truelearn.utils.visualisations.TreePlotter

Development

  • Contributing
    • Getting Started
    • Design Considerations
    • Testing the library
    • Building the documentation
    • Before/During PR
    • Releasing and Publishing TrueLearn
Back to top
Edit this page

Contributing#

Welcome! We’re happy to have you here. Thank you in advance for your contribution to TrueLearn.

This guide is intended for developers who want to contribute to the Truelearn project. In this guide, you will find information about how to install the project from source, how to run the tests, and how to build the documentation.

Contents#

  • Getting Started
  • Design Considerations
  • Testing the library
  • Building the documentation
  • Before/During PR
  • Releasing and Publishing TrueLearn
Next
Getting Started
Previous
truelearn.utils.visualisations.TreePlotter
Copyright © 2023, TrueLearn
Made with Sphinx and @pradyunsg's Furo
On this page
  • Contributing
    • Contents