Skip to content
Snippets Groups Projects
Commit 7c25ca0d authored by Maja Jablonska's avatar Maja Jablonska
Browse files

Add a minimal README.md

parent 8b47b2b4
1 merge request!46Merge COMBO 3.0 into master
# 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
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment