Welcome to the ODToolkit API Documentation Page

ODToolkit is a Python package that offers open-source implementation of various occupancy detection models and allows for comprehensive evaluation of these models on publicly available data sets collected from residential and commercial buildings. ODToolkit’s data processing and evaluation pipeline is shown below.

Pre-request: Python 3.4+.

ODToolkit Documentation

• Readme
  • License
  • Authors
  • How to get involved?
  • Contact
• Installation
  • Requirements
  • Installing ODToolkit
  • Code
• API documentation
  • Subpackages
  • core.easy_experiment module
• Changelog
  • v1.0.0

Demo Documentation

• Examples
  • Subpackages
  • core.easy_experiment module
• Sample Use Cases
  • Plotting the correlation matrix
  • Evaluating a specific model on a given data set
  • Evaluating multiple models on multiple data sets
• Extending the Toolkit
  • Adding a new data set
  • Adding a new model
  • Adding a new evaluation metric

Credits

• Dependencies