Skip to content

Commit 222ebd7

Browse files
committed
Update CLI docs
1 parent e1d9e1a commit 222ebd7

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

docs/_pages/v2/usage.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Usage: dm_evaluate [OPTIONS] {segmentation} {image|lidar}
3030
Evaluate model on dataset
3131

3232
Options:
33-
--model_format [torch|tensorflow]
33+
--model_format [torch|tensorflow|tensorflow_explicit]
3434
Trained model format [default: torch]
3535
--model PATH Trained model filename (TorchScript) or
3636
directory (TensorFlow SavedModel)
@@ -39,31 +39,40 @@ Options:
3939
[required]
4040
--model_cfg FILE JSON file with model configuration (norm.
4141
parameters, image size, etc.) [required]
42-
--dataset_format [gaia|rellis3d|goose|generic]
42+
--dataset_format [gaia|rellis3d|goose|generic|rugd]
4343
Dataset format [default: gaia]
4444
--dataset_fname FILE Parquet dataset file
4545
--dataset_dir DIRECTORY Dataset directory (used for 'Rellis3D' and
46-
'Wildscenes' format)
47-
--split_dir DIRECTORY Directory containing split files (used for 'Rellis3D'
48-
and 'Wildscenes' format)
46+
'Wildscenes' formats)
47+
--split_dir DIRECTORY Directory containing .lst or .csv split
48+
files (used for 'Rellis3D' and 'Wildscenes'
49+
formats, respectively)
4950
--train_dataset_dir DIRECTORY Train dataset directory (used for 'GOOSE'
5051
and 'Generic' formats)
5152
--val_dataset_dir DIRECTORY Validation dataset directory (used for
5253
'GOOSE' and 'Generic' formats)
5354
--test_dataset_dir DIRECTORY Test dataset directory (used for 'GOOSE' and
5455
'Generic' formats)
56+
--images_dir TEXT Directory containing data (used for 'RUGD'
57+
format)
58+
--labels_dir TEXT Directory containing annotations (used for
59+
'RUGD' format)
5560
--data_suffix TEXT Data suffix to be used to filter data (used
5661
for 'Generic' format)
5762
--label_suffix TEXT Label suffix to be used to filter labels
5863
(used for 'Generic' format)
59-
--dataset_ontology FILE JSON file containing dataset ontology (used
60-
for 'Generic' format)
61-
--split [train|val|test] Name of the split to be evaluated [default:
62-
test]
64+
--dataset_ontology FILE JSON containing dataset ontology (used for
65+
'Generic' and 'Rellis3D' formats)
66+
--split TEXT Name of the split or splits separated by
67+
commas to be evaluated [default: test]
6368
--ontology_translation FILE JSON file containing translation between
6469
dataset and model classes
6570
--out_fname PATH CSV file where the evaluation results will
66-
be stored [required]
71+
be stored
72+
--predictions_outdir PATH Directory where predictions (images/points
73+
and CSV) per sample will be stored. If not
74+
provided, predictions per sample will not be
75+
saved
6776
--help Show this message and exit.
6877
```
6978

@@ -77,7 +86,7 @@ dm_batch evaluate /path/to/batch_config.yaml
7786

7887
Docs:
7988
```shell
80-
Usage: dm_batch [OPTIONS] {evaluate} JOBS_CFG
89+
Usage: dm_batch [OPTIONS] {evaluate|computational_cost} JOBS_CFG
8190

8291
Perform detection metrics jobs in batch mode
8392

@@ -124,4 +133,5 @@ dataset:
124133
outdir: "/path/to/output_directory" # Path to output directory
125134
overwrite: false # Whether to overwrite existing output files or not
126135
ontology_translation: "/path/to/ontology_translation.json" # (Optional)
136+
store_results_per_sample: false # Whether to store the predictions for each sample
127137
```

0 commit comments

Comments
 (0)