Skip to content

Commit 69acd17

Browse files
committed
Update docs
Signed-off-by: Kim, Vinnam <[email protected]>
1 parent 18d2e05 commit 69acd17

File tree

5 files changed

+38
-3
lines changed

5 files changed

+38
-3
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Format
2+
3+
This command shows a list of supported import/export data formats in Datumaro.
4+
It is useful on a quick reference of data format name used for other CLI command such as [convert](../context_free/convert.md), [import](../context/sources.md#import-dataset), or [export](../context/export.md#export-datasets). For more detailed guides on each data format, please visit [our Data Formats section](../../data-formats).
5+
6+
Usage:
7+
8+
```console
9+
usage: datum format [-h] [-li | -le] [-d DELIMITER]
10+
```
11+
12+
Parameters:
13+
- `-h, --help` - Print the help message and exit.
14+
- `-d DELIMITER, --delimiter DELIMITER` - Seperator used to list data format names (default: `\n`). For example, `datum format -d ','` command displays
15+
```console
16+
Supported import formats:
17+
ade20k2017,ade20k2020,align_celeba,...
18+
```
19+
- `-li, --list-import` - List all supported import data format names
20+
- `-le, --list-export` - List all supported export data format names
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
===============
2+
Helper Commands
3+
===============
4+
5+
.. toctree::
6+
:maxdepth: 1
7+
:glob:
8+
9+
*

docs/source/docs/command-reference/overview.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
Overview
33
========
44

5-
The command line is split into the separate ``commands`` (:ref:`Context Commands`)
6-
and command ``contexts`` (:ref:`Context-free Commands`).
5+
The command line is split into three groups:
6+
``commands`` (:ref:`Context Commands`), command ``contexts`` (:ref:`Context-free Commands`), and ``helpers`` (:ref:`Helper Commands`).
77
Contexts group multiple commands related to a specific topic, e.g.
88
project operations, data source operations etc. Almost all the commands
99
operate on projects, so the ``project`` context and commands without a context

docs/source/docs/explanation/command_line.dot

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ digraph command_line {
3232
"util";
3333
}
3434

35+
subgraph helper {
36+
label = "Helper";
37+
"format";
38+
}
39+
3540
subgraph cluster_model {
3641
label = "Model";
3742
"madd" [label = "add";];
@@ -70,7 +75,7 @@ digraph command_line {
7075
"split_video";
7176
}
7277

73-
"datum" -> {"convert" "detect" "compare" "dinfo" "download" "explain" "filter" "generate" "merge" "patch" "search" "stats" "transform" "validate"};
78+
"datum" -> {"convert" "detect" "compare" "dinfo" "download" "explain" "filter" "generate" "merge" "patch" "search" "stats" "transform" "validate" "format"};
7479
"datum" -> {"model" "project" "source" "util"};
7580
"model" -> {"madd" "mremove" "run" "minfo"};
7681
"project" -> {"add" "create" "export" "import" "remove"};

docs/source/docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Docs
4848
command-reference/overview
4949
command-reference/context_free/index
5050
command-reference/context/index
51+
command-reference/helper/index
5152

5253
.. toctree::
5354
:maxdepth: 1

0 commit comments

Comments
 (0)