Skip to content
Snippets Groups Projects
Commit 4a3a4fd6 authored by Maja Jabłońska's avatar Maja Jabłońska
Browse files

Change python combo/main.py to combo in docs

parent 5d70b36b
Branches
Tags
No related merge requests found
...@@ -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
python combo/main.py --mode predict --model_path your_model_tar_gz --input_file your_conllu_file --output_file your_output_file combo --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
python combo/main.py --mode predict --model_path your_model_tar_gz --input_file your_text_file --output_file your_output_file --noconllu_format combo --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
python combo/main.py --mode predict --model_path your_model_tar_gz --input_file "-" combo --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
python combo/main.py --mode train \ combo --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 \
--serialization_dir directory_to_store_model_output_in --serialization_dir directory_to_store_model_output_in
...@@ -12,7 +12,7 @@ python combo/main.py --mode train \ ...@@ -12,7 +12,7 @@ python combo/main.py --mode train \
Options: Options:
```bash ```bash
python combo/main.py --helpfull combo --helpfull
``` ```
## Examples ## Examples
...@@ -22,26 +22,26 @@ are omitted. ...@@ -22,26 +22,26 @@ are omitted.
Train on multiple accelerators (default: train on all available ones) Train on multiple accelerators (default: train on all available ones)
```bash ```bash
python combo/main.py --mode train --n_cuda_devices 8 combo --mode train --n_cuda_devices 8
``` ```
Use pretrained transformer embeddings: Use pretrained transformer embeddings:
```bash ```bash
python combo/main.py --mode train --pretrained_transformer_name your_chosen_pretrained_transformer combo --mode train --pretrained_transformer_name your_chosen_pretrained_transformer
``` ```
Train only a dependency parser: Train only a dependency parser:
```bash ```bash
python combo/main.py --mode train --targets head,deprel combo --mode train --targets head,deprel
``` ```
Use additional features (e.g. part-of-speech tags) for training a dependency parser Use additional features (e.g. part-of-speech tags) for training a dependency parser
(```token``` and ```char``` are default features) (```token``` and ```char``` are default features)
```bash ```bash
python combo/main.py --mode train --targets head,deprel --features token,char,upostag combo --mode train --targets head,deprel --features token,char,upostag
``` ```
# Custom configuration # Custom configuration
...@@ -49,14 +49,14 @@ python combo/main.py --mode train --targets head,deprel --features token,char,up ...@@ -49,14 +49,14 @@ python combo/main.py --mode train --targets head,deprel --features token,char,up
Use a custom configuration: Use a custom configuration:
```bash ```bash
python combo/main.py --config_path configuration.json combo --config_path configuration.json
``` ```
Discard any flags (including default flag values - without this flag, the default values Discard any flags (including default flag values - without this flag, the default values
will override configuration!) will override configuration!)
```bash ```bash
python combo/main.py --config_path configuration.json --use_pure_config combo --config_path configuration.json --use_pure_config
``` ```
## Finetuning ## Finetuning
...@@ -64,7 +64,7 @@ python combo/main.py --config_path configuration.json --use_pure_config ...@@ -64,7 +64,7 @@ python combo/main.py --config_path configuration.json --use_pure_config
Finetune a pre-trained model: Finetune a pre-trained model:
```bash ```bash
python combo/main.py --mode train --finetune \ combo --mode train --finetune \
--finetuning_training_data_path your_training_path \ --finetuning_training_data_path your_training_path \
--finetuning_validation_data_path your_validation_path \ --finetuning_validation_data_path your_validation_path \
--model_path pretrained_model_path --model_path pretrained_model_path
......
...@@ -28,7 +28,7 @@ REQUIREMENTS = [ ...@@ -28,7 +28,7 @@ REQUIREMENTS = [
setup( setup(
name="combo-nlp", name="combo-nlp",
version="3.0.1", version="3.0.2",
author="Maja Jablonska", author="Maja Jablonska",
author_email="maja.jablonska@ipipan.waw.pl", author_email="maja.jablonska@ipipan.waw.pl",
install_requires=REQUIREMENTS, install_requires=REQUIREMENTS,
......
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