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.
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.
1 maintainer
Release files for returnn 1.20260922.214451
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| returnn-1.20260922.214451.tar.gz | 2.8 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| returnn-1.20260922.214451-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.7 MB
Release files / returnn-1.20260922.214451.tar.gz
| Download URL | returnn-1.20260922.214451.tar.gz |
|---|---|
| Size | 2.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0b6b829c445e601daf78d0ff8d2a4a2a3bb2311e624656d0bf1f3670315d1b9b
|
|
BLAKE2b-256 checksum How to use checksums |
e43e6770b2213175862697b2f9516c656379c2e169849166327f0a22e5afd5b5
|
| 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.20260922.214451-py3-none-any.whl
| Download URL | returnn-1.20260922.214451-py3-none-any.whl |
|---|---|
| Size | 1.9 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c3e78a653abb8d1ecfd012dc5ddb418fd98faa03d56da1c1aa7177d922baf74d
|
|
BLAKE2b-256 checksum How to use checksums |
7717e0838499bff960feac08d881a7fb710ba011b69e0d81aa2999d5f173f150
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
