Skip to content

Commit d041840

Browse files
VaghinakDevVaghinakDev
authored
Merge branch 'friday' into sa_server
2 parents dc247ad + da8fa78 commit d041840

File tree

268 files changed

+3849
-4280
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

268 files changed

+3849
-4280
lines changed

‎.pre-commit-config.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ repos:
1313
hooks:
1414
- id: black
1515
name: Code Formatter (black)
16-
- repo: 'https://gitlab.com/pycqa/flake8'
16+
- repo: 'https://github.com/PyCQA/flake8'
1717
rev: 3.8.2
1818
hooks:
1919
- id: flake8

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

‎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)