Skip to content

Commit 4c14732

Browse files
committed
doc strings fix
1 parent ff6a620 commit 4c14732

File tree

4 files changed

+17
-11
lines changed

4 files changed

+17
-11
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Changelog
22
All release highlights of this project will be documented in this file.
3+
## 4.4.8 - December 25, 2022
4+
### Added
5+
- New project types `Tiled`, `PointCloud`, `Other`.
6+
- `SAClient.get_project_by_id` _method_ to get project metadata by id.
7+
- `SAClient.get_folder_by_id` _method_ to get folder metadata by id.
8+
- `SAClient.get_item_by_id` _method_ to get item metadata by id.
9+
### Updated
10+
- `SAClient.consensus` _method_ to compute agreement scores between tag type annotations.
11+
###
312
## 4.4.7 - December 04, 2022
413
### Updated
514
- `SAClient.search_folders` _method_ to add a new `status` argument for searching folders via status.

src/superannotate/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
import sys
33

44

5-
__version__ = "4.4.8dev2"
5+
__version__ = "4.4.8b1"
66

77

88
sys.path.append(os.path.split(os.path.realpath(__file__))[0])

src/superannotate/lib/app/interface/sdk_interface.py

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ def create_project(
269269
ProjectTypes.validate(project_type)
270270
except TypeError:
271271
raise AppException(
272-
f"Please provide a valid project type: {', '.join(constants.ProjectType.titles())}"
272+
f"Please provide a valid project type: {', '.join(constants.ProjectType.titles())}."
273273
)
274274
response = self.controller.projects.create(
275275
entities.ProjectEntity(
@@ -1744,25 +1744,22 @@ def consensus(
17441744
self,
17451745
project: NotEmptyStr,
17461746
folder_names: List[NotEmptyStr],
1747-
export_root: Optional[Union[NotEmptyStr, Path]] = None,
17481747
image_list: Optional[List[NotEmptyStr]] = None,
17491748
annotation_type: Optional[AnnotationType] = "bbox",
1750-
show_plots: Optional[StrictBool] = False,
17511749
):
17521750
"""Computes consensus score for each instance of given images that are present in at least 2 of the given projects:
17531751
17541752
:param project: project name
17551753
:type project: str
1754+
17561755
:param folder_names: list of folder names in the project for which the scores will be computed
17571756
:type folder_names: list of str
1758-
:param export_root: root export path of the projects
1759-
:type export_root: Path-like (str or Path)
1757+
17601758
:param image_list: List of image names from the projects list that must be used. If None, then all images from the projects list will be used. Default: None
17611759
:type image_list: list
1762-
:param annot_type: Type of annotation instances to consider. Available candidates are: ["bbox", "polygon", "point"]
1763-
:type annot_type: str
1764-
:param show_plots: If True, show plots based on results of consensus computation. Default: False
1765-
:type show_plots: bool
1760+
1761+
:param annotation_type: Type of annotation instances to consider. Available candidates are: ["bbox", "polygon", "point"]
1762+
:type annotation_type: str
17661763
17671764
:return: Pandas DateFrame with columns (creatorEmail, QA, imageName, instanceId, className, area, attribute, folderName, score)
17681765
:rtype: pandas DataFrame

tests/integration/projects/test_create_project.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ def test_create_project_without_settings(self):
4646

4747
def test_create_project_wrong_type(self):
4848
with self.assertRaisesRegexp(AppException,
49-
"Please provide a valid project type: Vector, Pixel, Document, or Video."):
49+
"Please provide a valid project type: Vector, Pixel, Video, Document, Tiled, Other, PointCloud."):
5050
sa.create_project(self.PROJECT_1, "desc", "wrong_type")
5151

5252
def test_create_project_with_settings(self):

0 commit comments

Comments
 (0)