@@ -11,7 +11,7 @@ Remote functions
1111Initialization and authentication
1212_________________________________
1313
14- .. autofunction :: superannotate.init
14+ .. automethod :: superannotate.SAClient.__init__
1515
1616
1717.. _ref_projects :
@@ -20,61 +20,61 @@ Projects
2020________
2121
2222.. _ref_search_projects :
23- .. autofunction :: superannotate.search_projects
24- .. autofunction :: superannotate.create_project
25- .. autofunction :: superannotate.create_project_from_metadata
26- .. autofunction :: superannotate.clone_project
27- .. autofunction :: superannotate.delete_project
28- .. autofunction :: superannotate.rename_project
23+ .. automethod :: superannotate.SAClient .search_projects
24+ .. automethod :: superannotate.SAClient .create_project
25+ .. automethod :: superannotate.SAClient .create_project_from_metadata
26+ .. automethod :: superannotate.SAClient .clone_project
27+ .. automethod :: superannotate.SAClient .delete_project
28+ .. automethod :: superannotate.SAClient .rename_project
2929.. _ref_get_project_metadata :
30- .. autofunction :: superannotate.get_project_metadata
31- .. autofunction :: superannotate.get_project_image_count
32- .. autofunction :: superannotate.search_folders
33- .. autofunction :: superannotate.get_folder_metadata
34- .. autofunction :: superannotate.create_folder
35- .. autofunction :: superannotate.delete_folders
36- .. autofunction :: superannotate.upload_images_to_project
37- .. autofunction :: superannotate.attach_items_from_integrated_storage
38- .. autofunction :: superannotate.upload_image_to_project
39- .. autofunction :: superannotate.delete_annotations
30+ .. automethod :: superannotate.SAClient .get_project_metadata
31+ .. automethod :: superannotate.SAClient .get_project_image_count
32+ .. automethod :: superannotate.SAClient .search_folders
33+ .. automethod :: superannotate.SAClient .get_folder_metadata
34+ .. automethod :: superannotate.SAClient .create_folder
35+ .. automethod :: superannotate.SAClient .delete_folders
36+ .. automethod :: superannotate.SAClient .upload_images_to_project
37+ .. automethod :: superannotate.SAClient .attach_items_from_integrated_storage
38+ .. automethod :: superannotate.SAClient .upload_image_to_project
39+ .. automethod :: superannotate.SAClient .delete_annotations
4040.. _ref_upload_images_from_folder_to_project :
41- .. autofunction :: superannotate.upload_images_from_folder_to_project
42- .. autofunction :: superannotate.upload_video_to_project
43- .. autofunction :: superannotate.upload_videos_from_folder_to_project
41+ .. automethod :: superannotate.SAClient .upload_images_from_folder_to_project
42+ .. automethod :: superannotate.SAClient .upload_video_to_project
43+ .. automethod :: superannotate.SAClient .upload_videos_from_folder_to_project
4444.. _ref_upload_annotations_from_folder_to_project :
45- .. autofunction :: superannotate.upload_annotations_from_folder_to_project
46- .. autofunction :: superannotate.upload_preannotations_from_folder_to_project
47- .. autofunction :: superannotate.add_contributors_to_project
48- .. autofunction :: superannotate.get_project_settings
49- .. autofunction :: superannotate.set_project_default_image_quality_in_editor
50- .. autofunction :: superannotate.get_project_workflow
51- .. autofunction :: superannotate.set_project_workflow
45+ .. automethod :: superannotate.SAClient .upload_annotations_from_folder_to_project
46+ .. automethod :: superannotate.SAClient .upload_preannotations_from_folder_to_project
47+ .. automethod :: superannotate.SAClient .add_contributors_to_project
48+ .. automethod :: superannotate.SAClient .get_project_settings
49+ .. automethod :: superannotate.SAClient .set_project_default_image_quality_in_editor
50+ .. automethod :: superannotate.SAClient .get_project_workflow
51+ .. automethod :: superannotate.SAClient .set_project_workflow
5252
5353----------
5454
5555Exports
5656_______
5757
58- .. autofunction :: superannotate.prepare_export
59- .. autofunction :: superannotate.get_annotations
60- .. autofunction :: superannotate.get_annotations_per_frame
58+ .. automethod :: superannotate.SAClient .prepare_export
59+ .. automethod :: superannotate.SAClient .get_annotations
60+ .. automethod :: superannotate.SAClient .get_annotations_per_frame
6161.. _ref_download_export :
62- .. autofunction :: superannotate.download_export
63- .. autofunction :: superannotate.get_exports
62+ .. automethod :: superannotate.SAClient .download_export
63+ .. automethod :: superannotate.SAClient .get_exports
6464
6565----------
6666
6767Items
6868______
6969
70- .. autofunction :: superannotate.query
71- .. autofunction :: superannotate.search_items
72- .. autofunction :: superannotate.download_annotations
73- .. autofunction :: superannotate.attach_items
74- .. autofunction :: superannotate.copy_items
75- .. autofunction :: superannotate.move_items
76- .. autofunction :: superannotate.get_item_metadata
77- .. autofunction :: superannotate.set_annotation_statuses
70+ .. automethod :: superannotate.SAClient .query
71+ .. automethod :: superannotate.SAClient .search_items
72+ .. automethod :: superannotate.SAClient .download_annotations
73+ .. automethod :: superannotate.SAClient .attach_items
74+ .. automethod :: superannotate.SAClient .copy_items
75+ .. automethod :: superannotate.SAClient .move_items
76+ .. automethod :: superannotate.SAClient .get_item_metadata
77+ .. automethod :: superannotate.SAClient .set_annotation_statuses
7878
7979----------
8080
@@ -83,50 +83,50 @@ ______
8383
8484
8585.. _ref_search_images :
86- .. autofunction :: superannotate.download_image
87- .. autofunction :: superannotate.set_image_annotation_status
88- .. autofunction :: superannotate.set_images_annotation_statuses
89- .. autofunction :: superannotate.download_image_annotations
90- .. autofunction :: superannotate.upload_image_annotations
91- .. autofunction :: superannotate.copy_image
92- .. autofunction :: superannotate.pin_image
93- .. autofunction :: superannotate.assign_images
94- .. autofunction :: superannotate.delete_images
95- .. autofunction :: superannotate.add_annotation_bbox_to_image
96- .. autofunction :: superannotate.add_annotation_point_to_image
97- .. autofunction :: superannotate.add_annotation_comment_to_image
98- .. autofunction :: superannotate.upload_priority_scores
86+ .. automethod :: superannotate.SAClient .download_image
87+ .. automethod :: superannotate.SAClient .set_image_annotation_status
88+ .. automethod :: superannotate.SAClient .set_images_annotation_statuses
89+ .. automethod :: superannotate.SAClient .download_image_annotations
90+ .. automethod :: superannotate.SAClient .upload_image_annotations
91+ .. automethod :: superannotate.SAClient .copy_image
92+ .. automethod :: superannotate.SAClient .pin_image
93+ .. automethod :: superannotate.SAClient .assign_images
94+ .. automethod :: superannotate.SAClient .delete_images
95+ .. automethod :: superannotate.SAClient .add_annotation_bbox_to_image
96+ .. automethod :: superannotate.SAClient .add_annotation_point_to_image
97+ .. automethod :: superannotate.SAClient .add_annotation_comment_to_image
98+ .. automethod :: superannotate.SAClient .upload_priority_scores
9999
100100----------
101101
102102Annotation Classes
103103__________________
104104
105- .. autofunction :: superannotate.create_annotation_class
105+ .. automethod :: superannotate.SAClient .create_annotation_class
106106.. _ref_create_annotation_classes_from_classes_json :
107- .. autofunction :: superannotate.create_annotation_classes_from_classes_json
108- .. autofunction :: superannotate.search_annotation_classes
109- .. autofunction :: superannotate.download_annotation_classes_json
110- .. autofunction :: superannotate.delete_annotation_class
107+ .. automethod :: superannotate.SAClient .create_annotation_classes_from_classes_json
108+ .. automethod :: superannotate.SAClient .search_annotation_classes
109+ .. automethod :: superannotate.SAClient .download_annotation_classes_json
110+ .. automethod :: superannotate.SAClient .delete_annotation_class
111111
112112----------
113113
114114Team
115115_________________
116116
117- .. autofunction :: superannotate.get_team_metadata
118- .. autofunction :: superannotate.get_integrations
119- .. autofunction :: superannotate.invite_contributors_to_team
120- .. autofunction :: superannotate.search_team_contributors
117+ .. automethod :: superannotate.SAClient .get_team_metadata
118+ .. automethod :: superannotate.SAClient .get_integrations
119+ .. automethod :: superannotate.SAClient .invite_contributors_to_team
120+ .. automethod :: superannotate.SAClient .search_team_contributors
121121
122122----------
123123
124124Neural Network
125125_______________
126126
127- .. autofunction :: superannotate.download_model
128- .. autofunction :: superannotate.run_prediction
129- .. autofunction :: superannotate.search_models
127+ .. automethod :: superannotate.SAClient .download_model
128+ .. automethod :: superannotate.SAClient .run_prediction
129+ .. automethod :: superannotate.SAClient .search_models
130130
131131----------
132132
@@ -196,7 +196,7 @@ Export metadata example:
196196
197197
198198Integration metadata
199- _______________
199+ ______________________
200200
201201Integration metadata example:
202202
@@ -383,8 +383,8 @@ Working with annotations
383383________________________
384384
385385.. _ref_aggregate_annotations_as_df :
386- .. autofunction :: superannotate.validate_annotations
387- .. autofunction :: superannotate.aggregate_annotations_as_df
386+ .. automethod :: superannotate.SAClient .validate_annotations
387+ .. automethod :: superannotate.SAClient .aggregate_annotations_as_df
388388
389389----------
390390
@@ -398,5 +398,5 @@ _____________________________________________________________
398398Utility functions
399399--------------------------------
400400
401- .. autofunction :: superannotate.consensus
402- .. autofunction :: superannotate.benchmark
401+ .. autofunction :: superannotate.SAClient. consensus
402+ .. autofunction :: superannotate.SAClient. benchmark
0 commit comments