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