torchfilter documentation
==========================================

|build| |nbsp| |mypy| |nbsp| |lint| |nbsp| |coverage|

`torchfilter` is a library for discrete-time Bayesian filtering in PyTorch.
Source code on `Github <https://github.com/stanford-iprl-lab/torchfilter>`_.

.. toctree::
   :caption: API Reference
   :maxdepth: 3
   :titlesonly:
   :glob:

   api/torchfilter/base/index
   api/torchfilter/data/index
   api/torchfilter/filters/index
   api/torchfilter/train/index
   api/torchfilter/types/index
   api/torchfilter/utils/index


.. |build| image:: https://github.com/stanford-iprl-lab/torchfilter/workflows/build/badge.svg
   :alt: Build status icon
.. |mypy| image:: https://github.com/stanford-iprl-lab/torchfilter/workflows/mypy/badge.svg?branch=master
   :alt: Mypy status icon
.. |lint| image:: https://github.com/stanford-iprl-lab/torchfilter/workflows/lint/badge.svg
   :alt: Lint status icon
.. |coverage| image:: https://codecov.io/gh/stanford-iprl-lab/torchfilter/branch/master/graph/badge.svg
   :alt: Test coverage status icon
   :target: https://codecov.io/gh/stanford-iprl-lab/torchfilter
.. |nbsp| unicode:: 0xA0
   :trim: