update 2024-flipped-conformer folder

Author: robin-p-schmitt

2024-flipped-conformer/README

@@ -0,0 +1,21 @@
+Configs and recipes for our global attention-based encoder-decoder models.
+
+Paper: [The Conformer Encoder May Reverse the Time Dimension](https://arxiv.org/abs/2410.00680)
+
+We use [RETURNN](https://github.com/rwth-i6/returnn) based on PyTorch for training and our setups are based on [Sisyphus](https://github.com/rwth-i6/sisyphus).
+
+### Sisyphus Setup
+
+To prepare a sisyphus setup, you can run `prepare_sis_dir.sh <setup-dirname>`.
+After that, you need to create a `__init__.py` file inside
+the `config` folder and import the sis config there to run it.
+Here is an example to run chunked AED experiments for librispeech:
+```python
+from i6_experiments.users.schmitt.experiments.exp2024_08_27_flipped_conformer import flipped_conformer_exps
+
+
+def main():
+  flipped_conformer_exps.py()
+```
+Then, to run the experiments, you just call `./sis m` inside the setup dir. This
+will call the `main` function defined above.

2024-flipped-conformer/README.md

@@ -0,0 +1,46 @@
+#!/bin/bash
+
+set -e
+
+dirname=$1
+
+if [ ! $# -eq 1 ]; then
+  echo "Usage: $0 <setup-dirname>"
+  exit -1
+fi
+
+mkdir -p $dirname
+cd $dirname
+
+echo "Cloning repos"
+
+git clone git@github.com:rwth-i6/sisyphus.git
+ln -s sisyphus/sis .  # used to call the manager to run jobs
+
+git clone git@github.com:rwth-i6/returnn.git
+
+mkdir "recipe"
+git clone git@github.com:rwth-i6/i6_core.git recipe/i6_core
+git clone git@github.com:rwth-i6/i6_experiments.git recipe/i6_experiments
+
+echo "Creating setup dirs"
+
+mkdir "alias"  # sis jobs aliases (symlinks)
+mkdir "output"  # sis jobs outputs (symlinks)
+mkdir "work"  # sis jobs
+mkdir "config"  # main entry config is added here
+
+# sisyphus settings which needs to be adapted depending on the working environment
+cp recipe/i6_experiments/users/schmitt/experiments/exp2024_08_27_flipped_conformer/settings.py .
+
+# create dir for pycharm project to avoid indexing huge dirs (e.g work)
+echo "Creating dir for PyCharm project"
+
+pycharmProj="`basename $PWD`-proj"
+mkdir $pycharmProj
+cd $pycharmProj
+ln -s ../returnn .
+ln -s ../sisyphus .
+ln -s ../settings.py .
+ln -s ../recipe .
+ln -s ../config .