Skip to content

Commit 3eaf592

Browse files
committed
Improve docs
1 parent d04a676 commit 3eaf592

File tree

2 files changed

+23
-3
lines changed

2 files changed

+23
-3
lines changed

docs/source/cli.rst

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,17 @@ To upload preannotations from folder to project use:
101101
[--task "<task_type_for_COCO_projects>]
102102
103103
104-
Optional argument *format* accepts input preannotation format. It can have COCO or SuperAnnotate values.
105-
If the argument is not given then SuperAnnotate (the native preannotation format) assumed.
104+
Optional argument *format* accepts input annotation format. It can have COCO or SuperAnnotate values.
105+
If the argument is not given then SuperAnnotate (the native annotation format) is assumed.
106+
107+
Only when COCO format is specified *dataset-name* and *task* arguments are required.
108+
109+
*dataset-name* specifies JSON filename (without extension) in <folder_path>.
110+
111+
*task* specifies the COCO task for conversion. Please see
112+
:ref:`import_annotation_format <ref_import_annotation_format>` for more details.
113+
114+
The annotation classes will be created during the execution of this command.
106115
107116
----------
108117
@@ -121,7 +130,17 @@ To upload annotations from folder to project use:
121130
[--task "<task_type_for_COCO_projects>]
122131
123132
Optional argument *format* accepts input annotation format. It can have COCO or SuperAnnotate values.
124-
If the argument is not given then SuperAnnotate (the native annotation format) assumed.
133+
If the argument is not given then SuperAnnotate (the native annotation format) is assumed.
134+
135+
Only when COCO format is specified *dataset-name* and *task* arguments are required.
136+
137+
*dataset-name* specifies JSON filename (without extension) in <folder_path>.
138+
139+
*task* specifies the COCO task for conversion. Please see
140+
:ref:`import_annotation_format <ref_import_annotation_format>` for more details.
141+
142+
The annotation classes will be created during the execution of this command.
143+
125144

126145
----------
127146

docs/source/superannotate.sdk.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,7 @@ Converting annotation format to and from SuperAnnotate format
282282
_____________________________________________________________
283283

284284

285+
.. _ref_import_annotation_format:
285286
.. autofunction:: superannotate.import_annotation_format
286287
.. autofunction:: superannotate.export_annotation_format
287288
.. autofunction:: superannotate.convert_project_type

0 commit comments

Comments
 (0)