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

More documentation

parent c5031d73
Branches
Tags
1 merge request!46Merge COMBO 3.0 into master
# Default model configurations
For convenience, the file ```default_model.py``` contains a few default configurations for ComboModel,
Universal Dependencies DatasetReader and few other most commonly used.
\ No newline at end of file
...@@ -40,7 +40,7 @@ By default, COMBO uses the LAMBO tokenizer. ...@@ -40,7 +40,7 @@ By default, COMBO uses the LAMBO tokenizer.
Input and output are both in ```*.conllu``` format. Input and output are both in ```*.conllu``` format.
```bash ```bash
combo --mode predict --model_path your_model_tar_gz --input_file your_conllu_file --output_file your_output_file python combo/main.py --mode predict --model_path your_model_tar_gz --input_file your_conllu_file --output_file your_output_file
``` ```
### Raw text prediction ### Raw text prediction
...@@ -52,7 +52,7 @@ Input: one sentence per line. ...@@ -52,7 +52,7 @@ Input: one sentence per line.
Output: CONLL-u file. Output: CONLL-u file.
```bash ```bash
combo --mode predict --model_path your_model_tar_gz --input_file your_text_file --output_file your_output_file --noconllu_format python combo/main.py --mode predict --model_path your_model_tar_gz --input_file your_text_file --output_file your_output_file --noconllu_format
``` ```
### Console prediction ### Console prediction
...@@ -62,5 +62,5 @@ Works for models where input was text-based only. ...@@ -62,5 +62,5 @@ Works for models where input was text-based only.
Interactive testing in console (load model and just type sentence in console). Interactive testing in console (load model and just type sentence in console).
```bash ```bash
combo --mode predict --model_path your_model_tar_gz --input_file "-" python combo/main.py --mode predict --model_path your_model_tar_gz --input_file "-"
``` ```
\ No newline at end of file
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
Basic command: Basic command:
```bash ```bash
combo --mode train \ python combo/main.py --mode train \
--training_data_path your_training_path \ --training_data_path your_training_path \
--validation_data_path your_validation_path --validation_data_path your_validation_path
``` ```
...@@ -11,7 +11,7 @@ combo --mode train \ ...@@ -11,7 +11,7 @@ combo --mode train \
Options: Options:
```bash ```bash
combo --helpfull python combo/main.py --helpfull
``` ```
## Examples ## Examples
...@@ -20,7 +20,50 @@ For clarity, the training and validation data paths are omitted. ...@@ -20,7 +20,50 @@ For clarity, the training and validation data paths are omitted.
Train on multiple accelerators (default: train on all available ones) Train on multiple accelerators (default: train on all available ones)
```bash ```bash
combo --mode train python combo/main.py --mode train --n_cuda_devices 8
--n_cuda_devices 8
``` ```
Use pretrained transformer embeddings:
```bash
python combo/main.py --mode train --pretrained_transformer_name your_chosen_pretrained_transformer
```
Train only a dependency parser:
```bash
python combo/main.py --mode train --targets head,deprel
```
Use additional features (e.g. part-of-speech tags) for training a dependency parser
(```token``` and ```char``` are default features)
```bash
python combo/main.py --mode train --targets head,deprel --features token,char,upostag
```
# Custom configuration
Use a custom configuration:
```bash
python combo/main.py --config_path configuration.json
```
Discard any flags (including default flag values - without this flag, the default values
will override configuration!)
```bash
python combo/main.py --config_path configuration.json --use_pure_config
```
## Finetuning
Finetune a pre-trained model:
```bash
python combo/main.py --mode train --finetune \
--finetuning_training_data_path your_training_path \
--finetuning_validation_data_path your_validation_path \
--model_path pretrained_model_path
```
\ 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