diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..ae9e1f83b828b79abc58b0124e34dfbaf99e190e --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Hydra tutorial + +This repository contains a very simple network training using pytorch lightning flash. +The configuration management is done using Hydra (https://hydra.cc/), as the goal +of this code is to showcase how Hydra can be used. + +## Installing + +You can install this code with poetry (install poetry at : https://python-poetry.org/docs/#installation) using : + +``` +poetry install +``` + +## Running + +Once the project has been installed, you can run it with the following command: + +``` +poetry run flashtrain +``` + +You can, for example, change the learning rate using : + +``` +poetry run flashtrain model.learning_rate=1e-2 +``` \ No newline at end of file