From 7c25ca0dc0b8d086c1c2ec86de22e7891e1c395b Mon Sep 17 00:00:00 2001 From: Maja Jablonska <majajjablonska@gmail.com> Date: Thu, 5 Oct 2023 21:46:25 +1100 Subject: [PATCH] Add a minimal README.md --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..679ac48 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Installation + +Currently, COMBO is available as a git repository. In the cloned repository: + +## (Recommended) Create a Conda environment + +```bash +conda create -n combo python=3.9.16 +``` + +Make sure to install at least python 3.9.16. + +Not all of the requirements are available on `conda`, so `pip` is also required. + +```bash +conda install pip +``` + +## Install requirements + +Install the requirements using the `setup.py` file. + +```bash +pip install -e . +``` + +## Use COMBO as a python package + +```python +import combo +``` + +## Use COMBO CLI + +The minimal training example (make sure to download some conllu training and validation files) + +```bash +python combo/main.py --mode train --training_data_path <training conllu> --validation_data_path <validation conllu> +``` \ No newline at end of file -- GitLab