Source code and data for the paper "Differentiable Particle Filters: End-to-End Learning with Algorithmic Priors"
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
experiments
methods
plotting
utils
LICENSE
README.md
screenshot.png
setup.sh

README.md

Differentiable Particle Filters

Contact

Rico Jonschkowski (rico.jonschkowski@tu-berlin.de)

Introduction

This repository contains our source code for differentiable particle filters (DPFs) described in the paper "Differentiable Particle Filters: End-to-End Learning with Algorithmic Priors" (Jonschkowski et al. 2018). This implementation is meant to complement the paper. Our goal is to enable others to reproduce our results and to build on our research by reusing our code. We do not include extensive explanations here -- these can be found in our paper https://arxiv.org/pdf/1805.11122.pdf.

If you are using this implementation in your research, please consider giving credit by citing our paper:

@article{jonschkowski18,
    title = {{Differentiable Particle Filters: End-to-End Learning with Algorithmic Priors}},
    booktitle = {{Proceedings of Robotics: Science and Systems (RSS)}},
    author = {Jonschkowski, Rico and Rastogi, Divyam and Brock, Oliver},
    year = {2018},
}

Dependencies

Our code builds on python3 and the following libraries. It is important that the libraries are installed for python3 not python2.

numpy

sudo apt-get install python3-numpy

matplotlib

sudo apt-get install python3-matplotlib

TensorFlow --> https://www.tensorflow.org/install/, e.g.

pip3 install tensorflow

Sonnet --> https://github.com/deepmind/sonnet, e.g.

pip3 install dm-sonnet

Setup

The setup script downloads the data for training and testing (~2.5GB) and creates additional folders (for logging etc.). To perform these steps, simply run the following commands in the main folder of the repository:

chmod +x setup.sh
./setup.sh

Usage

After all dependencies are installed and setup is done, there is one more thing which needs to be done every time a new shell is opened before the code can be run. In the main repository folder, you need run the following command to append the parent directory to the PYTHONPATH. Alternatively, you can import the project into the PyCharm IDE and and run experiments/simple.py from there. The need for running this command comes from how PyCharm handles relative imports and relative paths.

export PYTHONPATH="${PYTHONPATH}:../"

After this is done, you can train and test a differentiable particle filter for global localization in maze 1 by running the following commands in the main folder:

cd experiments; python3 simple.py; cd ..

This command will first train the different models (motion model, observation likelihood estimator, and particle proposer) individually and then train them jointly end-to-end. The command line output will show the current losses on training and validation data (mean +- standard error), where ">>" indicates a new lowest validation loss. Training will stop if the best validation loss has not decreased for a while (e.g. 200 epochs). You should see something like this (the different plots are generated one after another):

Screenshot

As next steps, you can play around with the hyperparameters in utils/exp_utils.py, go through the differentiable particle filter code in methods/dpf.py, and run other experiments, e.g. applying the filter to the KITTI visual odometry task by running the following command (if your computer has enough memory :D).

cd experiments; python3 cross_validation_kitti.py; cd ..