From c4e813004af658c5bb0695abbdcc99027ee24aee Mon Sep 17 00:00:00 2001
From: Victor Joos <victor.joos@uclouvain.be>
Date: Mon, 27 Jun 2022 13:49:19 +0200
Subject: [PATCH] Adds README

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ae9e1f8
--- /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
-- 
GitLab