Skip to content

Commit a393f5d

Browse files
committed
improved documentation
1 parent c86c534 commit a393f5d

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

remo/api.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -373,10 +373,10 @@ def export_annotations(
373373
374374
Args:
375375
annotation_set_id: annotation set id
376-
annotation_format: can be one of ['json', 'coco', 'csv'], default='json'
377-
full_path: uses full image path (e.g. local path), it can be one of [True, False], default=True
378-
export_coordinates: converts output values to percentage or pixels, can be one of ['pixel', 'percent'], default='pixel'
379-
export_tags: exports the tags to a CSV file, it can be one of [True, False], default=True
376+
annotation_format: can be one of ['json', 'coco', 'csv']. Default: 'json'
377+
full_path: if True, appends file path to the filename. uses full image path. Default: True
378+
export_coordinates: converts output values to percentage or pixels, can be one of ['pixel', 'percent']. Default: 'pixel'
379+
export_tags: if True, exports the tags to a separate CSV file. Default: True
380380
Returns:
381381
annotation file content
382382
"""

remo/domain/dataset.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -531,7 +531,7 @@ def view_annotate(self, annotation_set_id: int = None):
531531
Opens browser on the annotation tool for the given annotation set
532532
533533
Args:
534-
annotation_set_id: annotation set id. If not specified, default one be used.
534+
annotation_set_id: annotation set id. If the dataset has only one annotation set, there is no need to specify the annotation_set_id.
535535
"""
536536
annotation_set = self.get_annotation_set(annotation_set_id)
537537
if annotation_set:
@@ -544,7 +544,7 @@ def view_annotation_stats(self, annotation_set_id: int = None):
544544
Opens browser on annotation set insights page
545545
546546
Args:
547-
annotation_set_id: annotation set id. If not specified, default one be used.
547+
annotation_set_id: annotation set id. If the dataset has only one annotation set, there is no need to specify the annotation_set_id.
548548
"""
549549
annotation_set = self.get_annotation_set(annotation_set_id)
550550
if annotation_set:

0 commit comments

Comments
 (0)