From 4a3a4fd6ce13045b2db905b2ae4406cd070fe388 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maja=20Jab=C5=82o=C5=84ska?= <mjablonska@e-science.pl>
Date: Wed, 17 Jan 2024 14:35:51 +0000
Subject: [PATCH] Change python combo/main.py to combo in docs

---
 docs/Prediction.md |  6 +++---
 docs/Training.md   | 18 +++++++++---------
 setup.py           |  2 +-
 3 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/docs/Prediction.md b/docs/Prediction.md
index 9b5db7d..0a055a7 100644
--- a/docs/Prediction.md
+++ b/docs/Prediction.md
@@ -40,7 +40,7 @@ By default, COMBO uses the LAMBO tokenizer.
 Input and output are both in ```*.conllu``` format.
 
 ```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
@@ -52,7 +52,7 @@ Input: one sentence per line.
 Output: CONLL-u file.
 
 ```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
@@ -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).
 
 ```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
diff --git a/docs/Training.md b/docs/Training.md
index 65bf1df..65cc70a 100644
--- a/docs/Training.md
+++ b/docs/Training.md
@@ -3,7 +3,7 @@
 Basic command:
 
 ```bash
-python combo/main.py --mode train \
+combo --mode train \
       --training_data_path your_training_path \
       --validation_data_path your_validation_path \
       --serialization_dir directory_to_store_model_output_in
@@ -12,7 +12,7 @@ python combo/main.py --mode train \
 Options:
 
 ```bash
-python combo/main.py --helpfull
+combo --helpfull
 ```
 
 ## Examples
@@ -22,26 +22,26 @@ are omitted.
 
 Train on multiple accelerators (default: train on all available ones)
 ```bash
-python combo/main.py --mode train --n_cuda_devices 8
+combo --mode train --n_cuda_devices 8
 ```
 
 Use pretrained transformer embeddings:
 
 ```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:
 
 ```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 
 (```token``` and ```char``` are default features)
 
 ```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
@@ -49,14 +49,14 @@ python combo/main.py --mode train --targets head,deprel --features token,char,up
 Use a custom configuration:
 
 ```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
 will override configuration!)
 
 ```bash
-python combo/main.py --config_path configuration.json --use_pure_config
+combo --config_path configuration.json --use_pure_config
 ```
 
 ## Finetuning
@@ -64,7 +64,7 @@ python combo/main.py --config_path configuration.json --use_pure_config
 Finetune a pre-trained model:
 
 ```bash
-python combo/main.py --mode train --finetune \
+combo --mode train --finetune \
        --finetuning_training_data_path your_training_path \
        --finetuning_validation_data_path your_validation_path \
        --model_path pretrained_model_path
diff --git a/setup.py b/setup.py
index 6943e29..e876ac0 100644
--- a/setup.py
+++ b/setup.py
@@ -28,7 +28,7 @@ REQUIREMENTS = [
 
 setup(
     name="combo-nlp",
-    version="3.0.1",
+    version="3.0.2",
     author="Maja Jablonska",
     author_email="maja.jablonska@ipipan.waw.pl",
     install_requires=REQUIREMENTS,
-- 
GitLab