diff options
| -rw-r--r-- | readme.md | 58 |
1 files changed, 30 insertions, 28 deletions
@@ -1,49 +1,51 @@ # SWR2-ACR -Automatic speech recognition model for the seminar spoken word recogniton 2 (SWR2) in the summer term 2023. + +Automatic speech recognition model for the seminar spoken word +recogniton 2 (SWR2) in the summer term 2023. # Installation + ## Installing poetry -``` -// installing poetry with the provided install script -curl -sSL https://install.python-poetry.org | python3 - -// adding poetry to your path -// Linux -echo export PATH="$HOME/.local/bin:$PATH" >> ~/.bashrc && source ~/.bashrc + // installing poetry with the provided install script + curl -sSL https://install.python-poetry.org | python3 - + + // adding poetry to your path + // Linux + echo export PATH="$HOME/.local/bin:$PATH" >> ~/.bashrc && source ~/.bashrc -// Mac -echo export PATH="$HOME/.local/bin:$PATH" >> ~/.zshrc && source ~/.zshrc -``` + // Mac + echo export PATH="$HOME/.local/bin:$PATH" >> ~/.zshrc && source ~/.zshrc ## Running on cpu or m1 gpu -``` -poetry lock && poetry install --with cpu -``` + + poetry lock && poetry install --with cpu ## Running on nvidia gpu -``` -poetry lock && poetry install --with gpu -``` + + poetry lock && poetry install --with gpu # Usage -## Training + +## Training + Train using the provided train script: -``` -poetry run train --data PATH/TO/DATA --lr 0.01 -``` + + poetry run train --data PATH/TO/DATA --lr 0.01 + ## Evaluation ## Inference -``` -poetry run recognize --data PATH/TO/FILE -``` + + poetry run recognize --data PATH/TO/FILE ## CI -To run the CI manually and not only on GitHub Actions, run `poetry run ./ci.sh`. + +To run the CI manually and not only on GitHub Actions, run +`poetry run ./ci.sh`. Alternatively, you can use the Makefile to run these commands manually -``` -make format -make lint -``` + make format + + make lint |