Skip to main content

Welcome to RETURNN

GitHub repository. RETURNN paper 2016, RETURNN paper 2018.

RETURNN - RWTH extensible training framework for universal recurrent neural networks, is a PyTorch/TensorFlow-based implementation of modern recurrent neural network architectures. It is optimized for fast and reliable training of recurrent neural networks in a multi-GPU environment.

The high-level features and goals of RETURNN are:

  • Simplicity

    • Writing config / code is simple & straight-forward (setting up experiment, defining model)

    • Debugging in case of problems is simple

    • Reading config / code is simple (defined model, training, decoding all becomes clear)

  • Flexibility

    • Allow for many different kinds of experiments / models

  • Efficiency

    • Training speed

    • Decoding speed

All items are important for research, decoding speed is esp. important for production.

See our Interspeech 2020 tutorial “Efficient and Flexible Implementation of Machine Learning for ASR and MT” video (slides) with an introduction of the core concepts.

More specific features include:

  • Mini-batch training of feed-forward neural networks

  • Sequence-chunking based batch training for recurrent neural networks

  • Long short-term memory recurrent neural networks including our own fast CUDA kernel

  • Multidimensional LSTM (GPU only, there is no CPU version)

  • Memory management for large data sets

  • Work distribution across multiple devices

  • Flexible and fast architecture which allows all kinds of encoder-attention-decoder models

See documentation. See basic usage and technological overview.

Here is the video recording of a RETURNN overview talk (slides, exercise sheet; hosted by eBay).

There are many example demos which work on artificially generated data, i.e. they should work as-is.

There are some real-world examples such as setups for speech recognition on the Switchboard or LibriSpeech corpus.

Some benchmark setups against other frameworks can be found here. The results are in the RETURNN paper 2016. Performance benchmarks of our LSTM kernel vs CuDNN and other TensorFlow kernels are in TensorFlow LSTM benchmark.

There is also a wiki. Questions can also be asked on StackOverflow using the RETURNN tag.

https://github.com/rwth-i6/returnn/workflows/CI/badge.svg

Dependencies

pip dependencies are listed in requirements.txt and requirements-dev, although some parts of the code may require additional dependencies (e.g. librosa, resampy) on-demand.

RETURNN supports Python >= 3.8. Bumps to the minimum Python version are listed in CHANGELOG.md.

TensorFlow-based setups require TensorFlow >= 2.2.

PyTorch-based setups require Torch >= 1.0.

Metadata

Release files for returnn 1.20261002.181755

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for returnn 1.20261002.181755
File Size Uploaded
returnn-1.20261002.181755.tar.gz 2.9 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for returnn 1.20261002.181755
File Interpreter ABI Platform
returnn-1.20261002.181755-py3-none-any.whl Python 3 none any Details

Total release size: 4.8 MB

Release files / returnn-1.20261002.181755.tar.gz

Download URL returnn-1.20261002.181755.tar.gz
Size 2.9 MB
Tags Source
SHA-256 checksum
How to use checksums
22ec69277ce731f3bd9d08771e2246d03deb9960d657cef37250c5a3adb8c3b6
BLAKE2b-256 checksum
How to use checksums
aadbf0460c25d240e56631917f9e7dde23a53ef4d5199d1afa0847bf8c8f3c5f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / returnn-1.20261002.181755-py3-none-any.whl

Download URL returnn-1.20261002.181755-py3-none-any.whl
Size 1.9 MB
Tags Python 3
SHA-256 checksum
How to use checksums
fbfa335f22d6d7c33da4d24b141aff5bedbec6128af2ed263d7b301f03b65011
BLAKE2b-256 checksum
How to use checksums
136e0c2c51463ce3229543d721c035ae95a8e7dbc394ac129224d3b727bf8258
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release history Release notifications | RSS feed

This release

1.20261002.181755 This release

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page