label-studio-sdk 1.0.8__py3-none-any.whl → 1.0.10__py3-none-any.whl

label_studio_sdk/comments/client.py

@@ -1,14 +1,14 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
+from ..core.client_wrapper import SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.comment import Comment
+from ..core.pydantic_utilities import parse_obj_as
 from json.decoder import JSONDecodeError
-
 from ..core.api_error import ApiError
-from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.jsonable_encoder import jsonable_encoder
-from ..core.pydantic_utilities import pydantic_v1
-from ..core.request_options import RequestOptions
-from ..types.comment import Comment
+from ..core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -27,6 +27,7 @@ class CommentsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[Comment]:
         """
+
         Get a list of comments for a specific project.
 
         Parameters
@@ -50,7 +51,7 @@ class CommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -60,12 +61,22 @@ class CommentsClient:
         _response = self._client_wrapper.httpx_client.request(
             "api/comments/",
             method="GET",
-            params={"project": project, "expand_created_by": expand_created_by, "annotation": annotation},
+            params={
+                "project": project,
+                "expand_created_by": expand_created_by,
+                "annotation": annotation,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[Comment], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[Comment],
+                    parse_obj_as(
+                        type_=typing.List[Comment],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -81,6 +92,7 @@ class CommentsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Comment:
         """
+
         Create a new comment.
 
         Parameters
@@ -103,7 +115,7 @@ class CommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -113,13 +125,27 @@ class CommentsClient:
         _response = self._client_wrapper.httpx_client.request(
             "api/comments/",
             method="POST",
-            json={"annotation": annotation, "project": project, "text": text, "is_resolved": is_resolved},
+            json={
+                "annotation": annotation,
+                "project": project,
+                "text": text,
+                "is_resolved": is_resolved,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Comment, _response.json())  # type: ignore
+                return typing.cast(
+                    Comment,
+                    parse_obj_as(
+                        type_=Comment,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -127,6 +153,7 @@ class CommentsClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Comment:
         """
+
         Get a specific comment.
 
         Parameters
@@ -144,7 +171,7 @@ class CommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -154,11 +181,19 @@ class CommentsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/comments/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/comments/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Comment, _response.json())  # type: ignore
+                return typing.cast(
+                    Comment,
+                    parse_obj_as(
+                        type_=Comment,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -166,6 +201,7 @@ class CommentsClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific comment.
 
         Parameters
@@ -182,7 +218,7 @@ class CommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -192,7 +228,9 @@ class CommentsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/comments/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/comments/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -213,6 +251,7 @@ class CommentsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Comment:
         """
+
         Update a specific comment.
 
         Parameters
@@ -238,7 +277,7 @@ class CommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -250,13 +289,27 @@ class CommentsClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/comments/{jsonable_encoder(id)}",
             method="PATCH",
-            json={"annotation": annotation, "project": project, "text": text, "is_resolved": is_resolved},
+            json={
+                "annotation": annotation,
+                "project": project,
+                "text": text,
+                "is_resolved": is_resolved,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Comment, _response.json())  # type: ignore
+                return typing.cast(
+                    Comment,
+                    parse_obj_as(
+                        type_=Comment,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -276,6 +329,7 @@ class AsyncCommentsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[Comment]:
         """
+
         Get a list of comments for a specific project.
 
         Parameters
@@ -299,22 +353,40 @@ class AsyncCommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.comments.list()
+
+
+        async def main() -> None:
+            await client.comments.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/comments/",
             method="GET",
-            params={"project": project, "expand_created_by": expand_created_by, "annotation": annotation},
+            params={
+                "project": project,
+                "expand_created_by": expand_created_by,
+                "annotation": annotation,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[Comment], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[Comment],
+                    parse_obj_as(
+                        type_=typing.List[Comment],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -330,6 +402,7 @@ class AsyncCommentsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Comment:
         """
+
         Create a new comment.
 
         Parameters
@@ -352,23 +425,45 @@ class AsyncCommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.comments.create()
+
+
+        async def main() -> None:
+            await client.comments.create()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/comments/",
             method="POST",
-            json={"annotation": annotation, "project": project, "text": text, "is_resolved": is_resolved},
+            json={
+                "annotation": annotation,
+                "project": project,
+                "text": text,
+                "is_resolved": is_resolved,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Comment, _response.json())  # type: ignore
+                return typing.cast(
+                    Comment,
+                    parse_obj_as(
+                        type_=Comment,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -376,6 +471,7 @@ class AsyncCommentsClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Comment:
         """
+
         Get a specific comment.
 
         Parameters
@@ -393,21 +489,37 @@ class AsyncCommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.comments.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.comments.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/comments/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/comments/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Comment, _response.json())  # type: ignore
+                return typing.cast(
+                    Comment,
+                    parse_obj_as(
+                        type_=Comment,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -415,6 +527,7 @@ class AsyncCommentsClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific comment.
 
         Parameters
@@ -431,17 +544,27 @@ class AsyncCommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.comments.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.comments.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/comments/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/comments/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -462,6 +585,7 @@ class AsyncCommentsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Comment:
         """
+
         Update a specific comment.
 
         Parameters
@@ -487,25 +611,47 @@ class AsyncCommentsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.comments.update(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.comments.update(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/comments/{jsonable_encoder(id)}",
             method="PATCH",
-            json={"annotation": annotation, "project": project, "text": text, "is_resolved": is_resolved},
+            json={
+                "annotation": annotation,
+                "project": project,
+                "text": text,
+                "is_resolved": is_resolved,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(Comment, _response.json())  # type: ignore
+                return typing.cast(
+                    Comment,
+                    parse_obj_as(
+                        type_=Comment,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)

label_studio_sdk/converter/converter.py

@@ -33,6 +33,7 @@ from label_studio_sdk.converter.utils import (
     convert_annotation_to_yolo,
     convert_annotation_to_yolo_obb,
 )
+from label_studio_sdk._extensions.label_studio_tools.core.utils.io import get_local_path
 
 logger = logging.getLogger(__name__)
 
@@ -55,6 +56,9 @@ class Format(Enum):
     YOLO = 11
     YOLO_OBB = 12
     CSV_OLD = 13
+    YOLO_WITH_IMAGES = 14
+    COCO_WITH_IMAGES = 15
+    YOLO_OBB_WITH_IMAGES = 16
 
     def __str__(self):
         return self.name
@@ -106,6 +110,12 @@ class Converter(object):
             "link": "https://labelstud.io/guide/export.html#COCO",
             "tags": ["image segmentation", "object detection"],
         },
+        Format.COCO_WITH_IMAGES: {
+            "title": "COCO with Images",
+            "description": "COCO format with images downloaded.",
+            "link": "https://labelstud.io/guide/export.html#COCO",
+            "tags": ["image segmentation", "object detection"],
+        },
         Format.VOC: {
             "title": "Pascal VOC XML",
             "description": "Popular XML format used for object detection and polygon image segmentation tasks.",
@@ -119,6 +129,12 @@ class Converter(object):
             "link": "https://labelstud.io/guide/export.html#YOLO",
             "tags": ["image segmentation", "object detection"],
         },
+        Format.YOLO_WITH_IMAGES: {
+            "title": "YOLO with Images",
+            "description": "YOLO format with images downloaded.",
+            "link": "https://labelstud.io/guide/export.html#YOLO",
+            "tags": ["image segmentation", "object detection"],
+        },
         Format.YOLO_OBB: {
             "title": "YOLOv8 OBB",
             "description": "Popular TXT format is created for each image file. Each txt file contains annotations for "
@@ -127,6 +143,12 @@ class Converter(object):
             "link": "https://labelstud.io/guide/export.html#YOLO",
             "tags": ["image segmentation", "object detection"],
         },
+        Format.YOLO_OBB_WITH_IMAGES: {
+            "title": "YOLOv8 OBB with Images",
+            "description": "YOLOv8 OBB format with images downloaded.",
+            "link": "https://labelstud.io/guide/export.html#YOLO",
+            "tags": ["image segmentation", "object detection"],
+        },
         Format.BRUSH_TO_NUMPY: {
             "title": "Brush labels to NumPy",
             "description": "Export your brush labels as NumPy 2d arrays. Each label outputs as one image.",
@@ -158,6 +180,8 @@ class Converter(object):
         output_tags=None,
         upload_dir=None,
         download_resources=True,
+        access_token=None,
+        hostname=None,
     ):
         """Initialize Label Studio Converter for Exports
 
@@ -171,6 +195,8 @@ class Converter(object):
         self.upload_dir = upload_dir
         self.download_resources = download_resources
         self._schema = None
+        self.access_token = access_token
+        self.hostname = hostname
 
         if isinstance(config, dict):
             self._schema = config
@@ -216,21 +242,23 @@ class Converter(object):
             )
         elif format == Format.CONLL2003:
             self.convert_to_conll2003(input_data, output_data, is_dir=is_dir)
-        elif format == Format.COCO:
+        elif format in [Format.COCO, Format.COCO_WITH_IMAGES]:
             image_dir = kwargs.get("image_dir")
+            self.download_resources = format == Format.COCO_WITH_IMAGES
             self.convert_to_coco(
                 input_data, output_data, output_image_dir=image_dir, is_dir=is_dir
             )
-        elif format == Format.YOLO or format == Format.YOLO_OBB:
+        elif format in [Format.YOLO, Format.YOLO_OBB, Format.YOLO_OBB_WITH_IMAGES, Format.YOLO_WITH_IMAGES]:
             image_dir = kwargs.get("image_dir")
             label_dir = kwargs.get("label_dir")
+            self.download_resources = format in [Format.YOLO_WITH_IMAGES, Format.YOLO_OBB_WITH_IMAGES]
             self.convert_to_yolo(
                 input_data,
                 output_data,
                 output_image_dir=image_dir,
                 output_label_dir=label_dir,
                 is_dir=is_dir,
-                is_obb=(format == Format.YOLO_OBB),
+                is_obb=(format in [Format.YOLO_OBB, Format.YOLO_OBB_WITH_IMAGES]),
             )
         elif format == Format.VOC:
             image_dir = kwargs.get("image_dir")
@@ -334,7 +362,9 @@ class Converter(object):
             and "Labels" in output_tag_types
         ):
             all_formats.remove(Format.COCO.name)
+            all_formats.remove(Format.COCO_WITH_IMAGES.name)
             all_formats.remove(Format.YOLO.name)
+            all_formats.remove(Format.YOLO_WITH_IMAGES.name)
         if not (
             "Image" in input_tag_types
             and (
@@ -353,6 +383,7 @@ class Converter(object):
             all_formats.remove(Format.ASR_MANIFEST.name)
         if is_mig or ('Video' in input_tag_types and 'TimelineLabels' in output_tag_types):
             all_formats.remove(Format.YOLO_OBB.name)
+            all_formats.remove(Format.YOLO_OBB_WITH_IMAGES.name)
 
         return all_formats
 
@@ -593,20 +624,25 @@ class Converter(object):
         )
         for item_idx, item in enumerate(item_iterator):
             image_path = item["input"][data_key]
+            task_id = item["id"]
             image_id = len(images)
             width = None
             height = None
             # download all images of the dataset, including the ones without annotations
             if not os.path.exists(image_path):
                 try:
-                    image_path = download(
-                        image_path,
-                        output_image_dir,
+                    image_path = get_local_path(
+                        url=image_path,
+                        hostname=self.hostname,
                         project_dir=self.project_dir,
-                        return_relative_path=True,
-                        upload_dir=self.upload_dir,
+                        image_dir=self.upload_dir,
+                        cache_dir=output_image_dir,
                         download_resources=self.download_resources,
+                        access_token=self.access_token,
+                        task_id=task_id,
                     )
+                    # make path relative to output_image_dir
+                    image_path = os.path.relpath(image_path, output_dir)
                 except:
                     logger.info(
                         "Unable to download {image_path}. The image of {item} will be skipped".format(
@@ -801,19 +837,24 @@ class Converter(object):
             image_paths = [image_paths] if isinstance(image_paths, str) else image_paths
             # download image(s)
             image_path = None
+            task_id = item["id"]
             # TODO: for multi-page annotation, this code won't produce correct relationships between page and annotated shapes
             # fixing the issue in RND-84
             for image_path in reversed(image_paths):
                 if not os.path.exists(image_path):
                     try:
-                        image_path = download(
-                            image_path,
-                            output_image_dir,
+                        image_path = get_local_path(
+                            url=image_path,
+                            hostname=self.hostname,
                             project_dir=self.project_dir,
-                            return_relative_path=True,
-                            upload_dir=self.upload_dir,
+                            image_dir=self.upload_dir,
+                            cache_dir=output_image_dir,
                             download_resources=self.download_resources,
+                            access_token=self.access_token,
+                            task_id=task_id,
                         )
+                        # make path relative to output_image_dir
+                        image_path = os.path.relpath(image_path, output_dir)
                     except:
                         logger.info(
                             "Unable to download {image_path}. The item {item} will be skipped".format(
@@ -920,6 +961,8 @@ class Converter(object):
                             annotations.append([category_id, x, y, w, h])
 
                     elif "polygonlabels" in label or "polygon" in label:
+                        if not ('points' in label):
+                            continue
                         points_abs = [(x / 100, y / 100) for x, y in label["points"]]
                         annotations.append(
                             [category_id]

label_studio_sdk/converter/imports/yolo.py

@@ -218,7 +218,7 @@ def add_parser(subparsers):
         "--image-ext",
         dest="image_ext",
         help="image extension to search: .jpeg or .jpg, .png",
-        default=".jpg",
+        default=".jpg,jpeg,.png",
     )
     yolo.add_argument(
         "--image-dims",