Skip to content

Commit 59f3e34

Browse files
VaghinakDevVaghinakDev
authored
Merge pull request #557 from superannotateai/docs_update
Docs update
2 parents bd7a685 + f769f9c commit 59f3e34

40 files changed

+1354
-1009
lines changed

‎.pre-commit-config.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ repos:
3636
- id: check-byte-order-marker
3737
- id: trailing-whitespace
3838
- id: end-of-file-fixer
39+
- repo: https://github.com/editorconfig-checker/editorconfig-checker.python
40+
rev: '' # pick a git hash / tag to point to
41+
hooks:
42+
- id: editorconfig-checker
43+
alias: ec
3944
# - repo: 'https://github.com/asottile/dead'
4045
# rev: v1.3.0
4146
# hooks:

‎docs/source/api_reference/api_annotation_class.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
==========
2+
Annotation Classes
3+
==========
4+
5+
.. automethod:: superannotate.SAClient.create_annotation_class
6+
.. _ref_create_annotation_classes_from_classes_json:
7+
.. automethod:: superannotate.SAClient.create_annotation_classes_from_classes_json
8+
.. automethod:: superannotate.SAClient.search_annotation_classes
9+
.. automethod:: superannotate.SAClient.download_annotation_classes_json
10+
.. automethod:: superannotate.SAClient.delete_annotation_class

‎docs/source/api_reference/api_client.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
==========
2+
SAClient interface
3+
==========
4+
5+
Contents
6+
========
7+
8+
.. toctree::
9+
:maxdepth: 8
10+
11+
api_project
12+
api_item
13+
api_export
14+
api_custom_metadata
15+
api_subset
16+
api_image
17+
api_annotation_class
18+
api_team
19+
api_neural_network
20+
21+
---

‎docs/source/api_reference/api_custom_metadata.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
==========
2+
Custom Metadata
3+
==========
4+
5+
.. automethod:: superannotate.SAClient.create_custom_fields
6+
.. automethod:: superannotate.SAClient.get_custom_fields
7+
.. automethod:: superannotate.SAClient.delete_custom_fields
8+
.. automethod:: superannotate.SAClient.upload_custom_values
9+
.. automethod:: superannotate.SAClient.delete_custom_values

‎docs/source/api_reference/api_export.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
==========
2+
Exports
3+
==========
4+
5+
.. automethod:: superannotate.SAClient.prepare_export
6+
.. automethod:: superannotate.SAClient.get_annotations
7+
.. automethod:: superannotate.SAClient.get_annotations_per_frame
8+
.. _ref_download_export:
9+
.. automethod:: superannotate.SAClient.download_export
10+
.. automethod:: superannotate.SAClient.get_exports

‎docs/source/api_reference/api_image.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
==========
2+
Images
3+
==========
4+
5+
6+
.. _ref_search_images:
7+
.. automethod:: superannotate.SAClient.download_image
8+
.. automethod:: superannotate.SAClient.download_image_annotations
9+
.. automethod:: superannotate.SAClient.upload_image_annotations
10+
.. automethod:: superannotate.SAClient.pin_image
11+
.. automethod:: superannotate.SAClient.upload_priority_scores

‎docs/source/api_reference/api_item.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
==========
2+
Items
3+
==========
4+
5+
6+
.. automethod:: superannotate.SAClient.query
7+
.. automethod:: superannotate.SAClient.get_item_by_id
8+
.. automethod:: superannotate.SAClient.search_items
9+
.. automethod:: superannotate.SAClient.download_annotations
10+
.. automethod:: superannotate.SAClient.attach_items
11+
.. automethod:: superannotate.SAClient.copy_items
12+
.. automethod:: superannotate.SAClient.move_items
13+
.. automethod:: superannotate.SAClient.delete_items
14+
.. automethod:: superannotate.SAClient.assign_items
15+
.. automethod:: superannotate.SAClient.unassign_items
16+
.. automethod:: superannotate.SAClient.get_item_metadata
17+
.. automethod:: superannotate.SAClient.set_annotation_statuses
18+
.. automethod:: superannotate.SAClient.set_approval_statuses

‎docs/source/api_reference/api_metadata.rst‎

Lines changed: 223 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
1+
==========
2+
Remote metadata reference
3+
==========
4+
5+
Projects metadata
6+
_________________
7+
.. _ref_metadata:
8+
Project metadata example:
9+
10+
.. code-block:: python
11+
12+
{
13+
"name": "Example Project test",
14+
"description": "test vector",
15+
"creator_id": "admin@superannotate.com",
16+
"updatedAt": "2020-08-31T05:43:43.118Z",
17+
"createdAt": "2020-08-31T05:43:43.118Z"
18+
"type": "Vector",
19+
"attachment_name": None,
20+
"attachment_path": None,
21+
"entropy_status": 1,
22+
"status": "NotStarted",
23+
"...": "..."
24+
}
25+
26+
27+
----------
28+
29+
Setting metadata
30+
_________________
31+
32+
Setting metadata example:
33+
34+
.. code-block:: python
35+
36+
{
37+
"attribute": "FrameRate",
38+
"value": 3
39+
}
40+
41+
42+
----------
43+
44+
Export metadata
45+
_______________
46+
47+
Export metadata example:
48+
49+
.. code-block:: python
50+
51+
{
52+
"name": "Aug 17 2020 15:44 First Name.zip",
53+
"user_id": "user@gmail.com",
54+
"status": 2,
55+
"createdAt": "2020-08-17T11:44:26.000Z",
56+
"...": "..."
57+
}
58+
59+
60+
----------
61+
62+
63+
Integration metadata
64+
______________________
65+
66+
Integration metadata example:
67+
68+
.. code-block:: python
69+
70+
{
71+
"name": "My S3 Bucket",
72+
"type": "aws",
73+
"root": "test-openseadragon-1212"
74+
}
75+
76+
77+
----------
78+
79+
80+
Item metadata
81+
_______________
82+
83+
Item metadata example:
84+
85+
.. code-block:: python
86+
87+
{
88+
"name": "example.jpeg",
89+
"path": "project/folder_1/meow.jpeg",
90+
"url": "https://sa-public-files.s3.../text_file_example_1.jpeg",
91+
"annotation_status": "NotStarted",
92+
"annotator_name": None,
93+
"qa_name": None,
94+
"entropy_value": None,
95+
"createdAt": "2022-02-15T20:46:44.000Z",
96+
"updatedAt": "2022-02-15T20:46:44.000Z"
97+
}
98+
99+
----------
100+
101+
102+
Image metadata
103+
_______________
104+
105+
106+
Image metadata example:
107+
108+
.. code-block:: python
109+
110+
{
111+
"name": "000000000001.jpg",
112+
"annotation_status": "Completed",
113+
"prediction_status": "NotStarted",
114+
"segmentation_status": "NotStarted",
115+
"annotator_id": None,
116+
"annotator_name": None,
117+
"qa_id": None,
118+
"qa_name": None,
119+
"entropy_value": None,
120+
"approval_status": None,
121+
"createdAt": "2020-08-18T07:30:06.000Z",
122+
"updatedAt": "2020-08-18T07:30:06.000Z"
123+
"is_pinned": 0,
124+
"...": "...",
125+
}
126+
127+
128+
----------
129+
130+
Priority score
131+
_______________
132+
133+
134+
Priority score example:
135+
136+
.. code-block:: python
137+
138+
{
139+
"name" : "image1.png",
140+
"priority": 0.567
141+
}
142+
143+
144+
----------
145+
146+
Attachment
147+
_______________
148+
149+
150+
Attachment example:
151+
152+
.. code-block:: python
153+
154+
{
155+
"url": "https://sa-public-files.s3.../text_file_example_1.jpeg",
156+
"name": "example.jpeg"
157+
}
158+
159+
160+
----------
161+
162+
.. _ref_class:
163+
164+
Annotation class metadata
165+
_________________________
166+
167+
168+
Annotation class metadata example:
169+
170+
.. code-block:: python
171+
172+
{
173+
"id": 4444,
174+
"name": "Human",
175+
"color": "#e4542b",
176+
"attribute_groups": [
177+
{
178+
"name": "tall",
179+
"attributes": [
180+
{
181+
"name": "yes"
182+
},
183+
{
184+
"name": "no"
185+
}
186+
]
187+
},
188+
{
189+
"name": "age",
190+
"attributes": [
191+
{
192+
"name": "young"
193+
},
194+
{
195+
"name": "old"
196+
}
197+
]
198+
}
199+
],
200+
201+
"...": "..."
202+
}
203+
204+
205+
206+
----------
207+
208+
Team contributor metadata
209+
_________________________
210+
211+
Team contributor metadata example:
212+
213+
.. code-block:: python
214+
215+
{
216+
"id": "admin@superannotate.com",
217+
"first_name": "First Name",
218+
"last_name": "Last Name",
219+
"email": "admin@superannotate.com",
220+
"user_role": 6
221+
"...": "...",
222+
}
223+

‎docs/source/api_reference/api_neural_network.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
==========
2+
Neural Network
3+
==========
4+
5+
6+
.. automethod:: superannotate.SAClient.download_model
7+
.. automethod:: superannotate.SAClient.run_prediction
8+
.. automethod:: superannotate.SAClient.search_models

‎docs/source/api_reference/api_project.rst‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
==========
2+
Projects
3+
==========
4+
.. _ref_projects:
5+
.. _ref_search_projects:
6+
.. automethod:: superannotate.SAClient.search_projects
7+
.. automethod:: superannotate.SAClient.create_project
8+
.. automethod:: superannotate.SAClient.create_project_from_metadata
9+
.. automethod:: superannotate.SAClient.clone_project
10+
.. automethod:: superannotate.SAClient.delete_project
11+
.. automethod:: superannotate.SAClient.rename_project
12+
.. _ref_get_project_metadata:
13+
.. automethod:: superannotate.SAClient.get_project_by_id
14+
.. automethod:: superannotate.SAClient.get_project_metadata
15+
.. automethod:: superannotate.SAClient.get_project_image_count
16+
.. automethod:: superannotate.SAClient.search_folders
17+
.. automethod:: superannotate.SAClient.assign_folder
18+
.. automethod:: superannotate.SAClient.unassign_folder
19+
.. automethod:: superannotate.SAClient.get_folder_by_id
20+
.. automethod:: superannotate.SAClient.get_folder_metadata
21+
.. automethod:: superannotate.SAClient.create_folder
22+
.. automethod:: superannotate.SAClient.delete_folders
23+
.. automethod:: superannotate.SAClient.upload_images_to_project
24+
.. automethod:: superannotate.SAClient.attach_items_from_integrated_storage
25+
.. automethod:: superannotate.SAClient.upload_image_to_project
26+
.. automethod:: superannotate.SAClient.upload_annotations
27+
.. automethod:: superannotate.SAClient.delete_annotations
28+
.. _ref_upload_images_from_folder_to_project:
29+
.. automethod:: superannotate.SAClient.upload_images_from_folder_to_project
30+
.. automethod:: superannotate.SAClient.upload_video_to_project
31+
.. automethod:: superannotate.SAClient.upload_videos_from_folder_to_project
32+
.. _ref_upload_annotations_from_folder_to_project:
33+
.. automethod:: superannotate.SAClient.upload_annotations_from_folder_to_project
34+
.. automethod:: superannotate.SAClient.add_contributors_to_project
35+
.. automethod:: superannotate.SAClient.get_project_settings
36+
.. automethod:: superannotate.SAClient.set_project_default_image_quality_in_editor
37+
.. automethod:: superannotate.SAClient.get_project_workflow
38+
.. automethod:: superannotate.SAClient.set_project_workflow

0 commit comments

Comments
 (0)