From 9b38346383d2369b4751705e92791202742822fd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20Koz=C5=82owski?=
 <michalkozlowski936@gmail.com>
Date: Tue, 10 Jan 2023 18:29:00 +0100
Subject: [PATCH] readme

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index e69de29..278d769 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,17 @@
+# Donut script for train and eval
+
+## Instalation/setup:
+-> `pip install -r requirements.txt`
+-> `export HUG_TOKEN=YourToken` - token needed for pushing model to huggingface after training
+
+## Usage:
+
+### Train
+-> `python train --config config-train.yaml`
+
+
+### Evaluation
+-> `python eval --config config-eval.yaml`
+
+## Configuration
+Need to suply config file like `config-eval.yaml` for evaluation or `config-train.yaml` for traning
\ No newline at end of file