Skip to content
This repository was archived by the owner on Jan 5, 2023. It is now read-only.

Commit 684e90a

Browse files
committed
Update README
1 parent c029c10 commit 684e90a

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ three subcommands `train`, `translate` and `test`.
113113
**`nmtpy train`**
114114

115115
```
116-
usage: nmtpy train [-h] -C CONFIG [-s SUFFIX] [overrides [overrides ...]]
116+
usage: nmtpy train [-h] -C CONFIG [-s SUFFIX] [-S] [overrides [overrides ...]]
117117
118118
positional arguments:
119119
overrides (section).key:value overrides for config
@@ -124,13 +124,14 @@ optional arguments:
124124
Experiment configuration file
125125
-s SUFFIX, --suffix SUFFIX
126126
Optional experiment suffix.
127-
127+
-S, --short Use short experiment id in filenames.
128128
```
129129

130130
**`nmtpy translate`**
131131
```
132-
usage: nmtpy translate [-h] [-n] -s SPLITS [-b BATCH_SIZE] [-k BEAM_SIZE]
133-
[-m MAX_LEN] [-p] [-u] [-d DEVICE] [-e]
132+
usage: nmtpy translate [-h] [-n] [-b BATCH_SIZE] [-k BEAM_SIZE] [-m MAX_LEN]
133+
[-a LP_ALPHA] [-d DEVICE_ID] (-s SPLITS | -S SOURCE) -o
134+
OUTPUT
134135
models [models ...]
135136
136137
positional arguments:
@@ -139,18 +140,23 @@ positional arguments:
139140
optional arguments:
140141
-h, --help show this help message and exit
141142
-n, --disable-filters
142-
Disable text filters given in config.
143-
-s SPLITS, --splits SPLITS
144-
Comma separated splits to translate
143+
Disable eval_filters given in config
145144
-b BATCH_SIZE, --batch-size BATCH_SIZE
146145
Batch size for beam-search
147146
-k BEAM_SIZE, --beam-size BEAM_SIZE
148147
Beam size for beam-search
149148
-m MAX_LEN, --max-len MAX_LEN
150-
Maximum sequence length
151-
-d DEVICE, --device DEVICE
149+
Maximum seq. limit (Default: 200)
150+
-a LP_ALPHA, --lp-alpha LP_ALPHA
151+
Apply length-penalty (Default: 0.)
152+
-d DEVICE_ID, --device-id DEVICE_ID
152153
Select GPU device(s)
153-
-e, --ensemble Enable ensembling for multiple models.
154+
-s SPLITS, --splits SPLITS
155+
Comma separated splits from config file
156+
-S SOURCE, --source SOURCE
157+
Comma-separated key:value pairs to provide new inputs.
158+
-o OUTPUT, --output OUTPUT
159+
Output filename prefix
154160
```
155161

156162
#### Experiment Configuration

0 commit comments

Comments
 (0)