Soft DTW for PyTorch in CUDA

Fast CUDA implementation of soft-DTW for PyTorch. Based on pytorch-softdtw but can run up to 100x faster! Both forward() and backward() passes are implemented using CUDA.

My implementation is partly inspired by "Developing a pattern discovery method in time series data and its GPU acceleration" wherein a diagonal-based implementation of the Belman recursion is proposed.

Getting Started

This code depends on PyTorch and Numba. Just include soft_dtw_cuda.py in your projects, and you should be good to go!

You can also run the included profiler/test (tested with Python v3.6), and see the speedups you'd get:

git clone https://github.com/Maghoumi/pytorch-softdtw-cuda
cd pytorch-softdtw-cuda
python soft_dtw_cuda.py

Example Usage

A sample code is already provided in the script. Here's a quick example:

from soft_dtw_cuda import SoftDTW

# Create the sequences
batch_size, len_x, len_y, dims = 8, 15, 12, 5
x = torch.rand((batch_size, len_x, dims), requires_grad=True)
y = torch.rand((batch_size, len_y, dims))

# Create the "criterion" object
sdtw = SoftDTW(use_cuda=True, gamma=0.1)

# Compute the loss value
loss = sdtw(x, y)  # Just like any torch.nn.xyzLoss()

# Aggregate and call backward()
loss.mean().backward()

Demo Project

Checkout DeepNAG, our deep non-adversarial gesture generator. We show that a RNN-based gesture generator trained with soft DTW can outperform the same generator trained using a GAN framework.

Citation

If you use this code in your research, please cite the following publications:

@phdthesis{maghoumi2020dissertation,
  title={{Deep Recurrent Networks for Gesture Recognition and Synthesis}},
  author={Mehran Maghoumi},
  year={2020},
  school={University of Central Florida Orlando, Florida}
}

@misc{maghoumi2020deepnag,
      title={{DeepNAG: Deep Non-Adversarial Gesture Generation}},
      author={Mehran Maghoumi and Eugene M. Taranta II and Joseph J. LaViola Jr},
      year={2020},
      eprint={2011.09149},
      archivePrefix={arXiv},
      primaryClass={cs.CV}
}

FAQ:

This is awesome! What can I do to help?

Consider starring this repository if you find it helpful. Also, don't forget to thank the author of pytorch-softdtw for his CPU implementation.

Also, please consider contributing to this project by improving the performance, addressing existing limitations, etc. PRs are greatly welcome!

Does it support pruning?

Yes! Use the bandwitdh argument to specify the Sakoe-Chiba bandwidth to use for pruning.

How fast does it run?

It depends on your batch size and sequence length. The longer the sequences and the larger the batch size, the faster this code runs.

Here's what I get with Ryzen 9 3900x and Titan RTX:

Profiling forward() + backward() times for batch_size=128, seq_len_a=17, seq_len_b=15, dims=2...
	CPU:      0.006849725800202577
	GPU:      0.0017813925996961189
	Speedup:  3.8451522709654493

Profiling forward() + backward() times for batch_size=512, seq_len_a=64, seq_len_b=64, dims=2...
	CPU:      0.23511007620036253
	GPU:      0.0038500409998960096
	Speedup:  61.06690193863206

Profiling forward() + backward() times for batch_size=512, seq_len_a=256, seq_len_b=256, dims=2...
	CPU:      3.7511388037995856
	GPU:      0.03190629960008664
	Speedup:  117.5673409582539

Note that there are tons of opportunities for optimizing this code further (e.g. various CUDA optimizations such as the use shared memory, etc.). Contributions/improvements are greatly appreciated!

How accurate are the results?

Depends on the length of your inputs. Because of the sequential nature of this code, the longer your input sequences are, the higher numerical errors become due to accumulation. Especially in the backward() call, you could see floating point errors of up to 1e-3 on uniform random inputs in the range [0, 1) in the resulting derivative tensor.

The unit tests included in soft_dtw_cuda.py verify the results against the CPU implementation.

What are the limitations?

Some limitations are:

All sequences in the same batch should have the same length / number of features.
Inputs cannot have lengths longer than 1024 (due to CUDA limitations on the maximum block size). The code will warn if your sequence length is too long, and will fall-back to the CPU implementation.
You may run out of CUDA resources if your inputs are long (but still less than 1024). See below.

I'm seeing `CUDA_ERROR_LAUNCH_OUT_OF_RESOURCES`. Help!

This means the length of your sequences is too long, and your GPU cannot spawn a sufficient number of threads. This is related to point 4 above in the "limitations". I'm not sure if it's possible to query the CUDA device in Numba to see if launching the kernel is possible given the number of necessary threads. In these cases consider using the CPU implementation.

License

This project is licensed under the MIT License.

rnwatanabe/pytorch-softdtw-cuda