label-studio-sdk 1.0.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

label_studio_sdk/import_storage/s3/types/s3create_response.py

@@ -8,29 +8,54 @@ from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 
 
 class S3CreateResponse(pydantic_v1.BaseModel):
-    project: typing.Optional[int] = pydantic_v1.Field(default=None)
+    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
-    Project ID
+    Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
     """
 
-    bucket: typing.Optional[str] = pydantic_v1.Field(default=None)
+    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
     """
-    S3 bucket name
+    Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
     """
 
-    prefix: typing.Optional[str] = pydantic_v1.Field(default=None)
+    presign: typing.Optional[bool] = pydantic_v1.Field(default=None)
     """
-    S3 bucket prefix
+    Presign URLs for download
     """
 
-    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
+    presign_ttl: typing.Optional[int] = pydantic_v1.Field(default=None)
     """
-    Cloud storage regex for filtering objects
+    Presign TTL in minutes
     """
 
-    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    recursive_scan: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Scan recursively
+    """
+
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage title
+    """
+
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage description
+    """
+
+    project: typing.Optional[int] = pydantic_v1.Field(default=None)
     """
-    Interpret objects as BLOBs and generate URLs
+    Project ID
+    """
+
+    bucket: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    S3 bucket name
+    """
+
+    prefix: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    S3 bucket prefix
     """
 
     aws_access_key_id: typing.Optional[str] = pydantic_v1.Field(default=None)
@@ -63,21 +88,6 @@ class S3CreateResponse(pydantic_v1.BaseModel):
     S3 Endpoint
     """
 
-    presign: typing.Optional[bool] = pydantic_v1.Field(default=None)
-    """
-    Presign URLs for download
-    """
-
-    presign_ttl: typing.Optional[int] = pydantic_v1.Field(default=None)
-    """
-    Presign TTL in seconds
-    """
-
-    recursive_scan: typing.Optional[bool] = pydantic_v1.Field(default=None)
-    """
-    Scan recursively
-    """
-
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
         return super().json(**kwargs_with_defaults)

label_studio_sdk/import_storage/s3/types/s3update_response.py

@@ -8,29 +8,54 @@ from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 
 
 class S3UpdateResponse(pydantic_v1.BaseModel):
-    project: typing.Optional[int] = pydantic_v1.Field(default=None)
+    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
-    Project ID
+    Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
     """
 
-    bucket: typing.Optional[str] = pydantic_v1.Field(default=None)
+    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
     """
-    S3 bucket name
+    Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
     """
 
-    prefix: typing.Optional[str] = pydantic_v1.Field(default=None)
+    presign: typing.Optional[bool] = pydantic_v1.Field(default=None)
     """
-    S3 bucket prefix
+    Presign URLs for download
     """
 
-    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
+    presign_ttl: typing.Optional[int] = pydantic_v1.Field(default=None)
     """
-    Cloud storage regex for filtering objects
+    Presign TTL in minutes
     """
 
-    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    recursive_scan: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Scan recursively
+    """
+
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage title
+    """
+
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage description
+    """
+
+    project: typing.Optional[int] = pydantic_v1.Field(default=None)
     """
-    Interpret objects as BLOBs and generate URLs
+    Project ID
+    """
+
+    bucket: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    S3 bucket name
+    """
+
+    prefix: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    S3 bucket prefix
     """
 
     aws_access_key_id: typing.Optional[str] = pydantic_v1.Field(default=None)
@@ -63,21 +88,6 @@ class S3UpdateResponse(pydantic_v1.BaseModel):
     S3 Endpoint
     """
 
-    presign: typing.Optional[bool] = pydantic_v1.Field(default=None)
-    """
-    Presign URLs for download
-    """
-
-    presign_ttl: typing.Optional[int] = pydantic_v1.Field(default=None)
-    """
-    Presign TTL in seconds
-    """
-
-    recursive_scan: typing.Optional[bool] = pydantic_v1.Field(default=None)
-    """
-    Scan recursively
-    """
-
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
         return super().json(**kwargs_with_defaults)

label_studio_sdk/{_legacy/label_interface → label_interface}/base.py

@@ -2,6 +2,16 @@ from pydantic import BaseModel
 from typing import Dict, Optional, List, Tuple, Any, Callable
 
 
+def get_tag_class(name, default_mapping, re_mapping=None):
+    """ """
+    lc_name = name.lower()
+    if re_mapping and lc_name in re_mapping:
+        return re_mapping.get(lc_name)
+    else:
+        class_name = default_mapping.get(name.lower())
+        return class_name
+
+
 class LabelStudioTag(BaseModel):
     """
     Base class for a LabelStudio Tag

label_studio_sdk/{_legacy/label_interface → label_interface}/control_tags.py

@@ -3,9 +3,9 @@
 
 import xml.etree.ElementTree
 from typing import Type, Dict, Optional, List, Tuple, Any, Union
-from pydantic import BaseModel, confloat
+from pydantic import BaseModel, confloat, Field, validator
 
-from .base import LabelStudioTag
+from .base import LabelStudioTag, get_tag_class
 from .region import Region
 from .object_tags import ObjectTag
 
@@ -42,12 +42,6 @@ _TAG_TO_CLASS = {
 }
 
 
-def get_tag_class(name):
-    """ """
-    class_name = _TAG_TO_CLASS.get(name.lower())
-    return globals().get(class_name, None)
-
-
 class ControlTag(LabelStudioTag):
     """
     Class that represents a ControlTag in Label Studio
@@ -100,7 +94,7 @@ class ControlTag(LabelStudioTag):
         )
 
     @classmethod
-    def parse_node(cls, tag: xml.etree.ElementTree.Element) -> "ControlTag":
+    def parse_node(cls, tag: xml.etree.ElementTree.Element, tags_mapping=None) -> "ControlTag":
         """
         Parse tag into a tag info
 
@@ -114,8 +108,10 @@ class ControlTag(LabelStudioTag):
         ControlTag
             The parsed tag
         """
-        tag_class = get_tag_class(tag.tag) or cls
-
+        tag_class = get_tag_class(tag.tag, _TAG_TO_CLASS, re_mapping=tags_mapping) or cls
+        if isinstance(tag_class, str):
+            tag_class = globals().get(tag_class, None)
+        
         tag_info = {
             "tag": tag.tag,
             "name": tag.attrib["name"],
@@ -142,7 +138,9 @@ class ControlTag(LabelStudioTag):
         if conditionals:
             tag_info["conditionals"] = conditionals
 
-        if tag.attrib.get("value", "empty")[0] == "$" or tag.attrib.get("apiUrl"):
+        val = tag.attrib.get("value", None)
+        if (val is not None and len(val) and val[0] == "$") or \
+           tag.attrib.get("apiUrl"):
             tag_info["dynamic_value"] = True
 
         return tag_class(**tag_info)
@@ -290,6 +288,7 @@ class ControlTag(LabelStudioTag):
         bool
             True if the value is valid, False otherwise
         """
+        
         if hasattr(self, "_label_attr_name"):
             if not self._validate_value_labels(value):
                 return False
@@ -361,7 +360,7 @@ class ControlTag(LabelStudioTag):
         obj = self.find_object_by_name(to_name)
         cls = self._value_class
         value = cls(**kwargs)
-
+        
         return Region(from_tag=self, to_tag=obj, value=value)
 
     def _label_with_labels(
@@ -419,8 +418,8 @@ class ControlTag(LabelStudioTag):
         **kwargs,
     ) -> Region:
         """
-        This method creates a new Region object with the specified label applied.
-        If not labels are provided, it creates a new instance of the value class with the provided arguments and keyword arguments.
+        This method creates a new Region object with the specified label.
+        
         If labels are provided, it creates a new instance of the value class with the provided arguments and keyword arguments and adds the labels to the Region object.
 
         Parameters:
@@ -459,13 +458,13 @@ class ControlTag(LabelStudioTag):
 
 
 class SpanSelection(BaseModel):
-    start: str
-    end: str
+    start: int = Field(..., ge=0)
+    end: int = Field(..., ge=0)
 
 
 class SpanSelectionOffsets(SpanSelection):
-    startOffset: int
-    endOffset: int
+    startOffset: int = Field(..., ge=0)
+    endOffset: int = Field(..., ge=0)
 
 
 class ChoicesValue(BaseModel):
@@ -492,11 +491,42 @@ class LabelsTag(ControlTag):
 
 ## Image tags
 
+def validate_rle(list):
+    """
+    Validate if a list is correctly formatted in Run-Length Encoding (RLE).
+
+    A correctly formatted RLE list should follow 'value, count' pairs. 
+    For example, [2,3,3,2] is a valid RLE list representing [2,2,2,3,3].
+
+    Parameters:
+        list : a list of integers
+
+    Returns:
+        bool : True if the list is correctly formatted in RLE, False otherwise
+    """
+    # If the list length is odd, it's invalid.
+    if len(list) % 2 != 0:
+        return False
+
+    # Check 'value, count' pairs. The count should always be greater than zero.
+    for i in range(1, len(list), 2):
+        if list[i] <= 0:
+            return False
+
+    return True
+
 
 class BrushValue(BaseModel):
-    format: str
+    format: str = "rle"
     rle: List[int]
 
+    @validator('rle')
+    def validate_rle(cls, rle_data):
+        if not validate_rle(rle_data):
+            raise ValueError('Invalid RLE format')
+        
+        return rle_data
+
 
 class BrushLabelsValue(BrushValue):
     brushlabels: List[str]
@@ -507,8 +537,14 @@ class BrushTag(ControlTag):
 
     _value_class: Type[BrushValue] = BrushValue
 
+    # def validate_value(self, value) -> bool:
+    #     res = super().validate_value(value)
+    #     if res is True and value.get("format") == "rle":
+    #         return validate_rle(value.get("rle"))
+        
+    #     return res
 
-class BrushLabelsTag(ControlTag):
+class BrushLabelsTag(BrushTag):
     """ """
 
     _label_attr_name: str = "brushlabels"
@@ -520,7 +556,7 @@ class EllipseValue(BaseModel):
     y: confloat(le=100)
     radiusX: confloat(le=50)
     radiusY: confloat(le=50)
-    rotation: confloat(le=360) = 0
+    rotation: Optional[confloat(le=360)] = 0
 
 
 class EllipseLabelsValue(EllipseValue):
@@ -563,7 +599,7 @@ class KeyPointLabelsTag(ControlTag):
 
 
 class PolygonValue(BaseModel):
-    points: Tuple[confloat(le=100), confloat(le=100)]
+    points: List[Tuple[confloat(le=100), confloat(le=100)]]
 
 
 class PolygonLabelsValue(PolygonValue):
@@ -575,9 +611,6 @@ class PolygonTag(ControlTag):
 
     _value_class: Type[PolygonValue] = PolygonValue
 
-    def label(self, *args, **kwargs):
-        """ """
-
 
 class PolygonLabelsTag(ControlTag):
     """ """
@@ -591,7 +624,7 @@ class RectangleValue(BaseModel):
     y: confloat(le=100)
     width: confloat(le=100)
     height: confloat(le=100)
-    rotation: confloat(le=360)
+    rotation: Optional[confloat(le=360)] = 0
 
 
 class RectangleLabelsValue(RectangleValue):
@@ -611,42 +644,45 @@ class RectangleLabelsTag(ControlTag):
     _value_class: Type[RectangleLabelsValue] = RectangleLabelsValue
 
 
-class VideoRectangleValue(BaseModel):
-    x: float
-    y: float
-    width: float
-    height: float
-    rotation: float
+class VideoRectangleSequenceValue(BaseModel):
+    x: confloat(le=100)
+    y: confloat(le=100)
+    time: float
+    frame: int
+    width: confloat(le=100)
+    height: confloat(le=100)
+    rotation: Optional[float] = 0
 
 
+class VideoRectangleValue(BaseModel):
+    framesCount: int
+    duration: float
+    sequence: List[VideoRectangleSequenceValue]
+    labels: Optional[List[str]]
+    
+    
 class VideoRectangleTag(ControlTag):
     """ """
-
+    _label_attr_name: str = "labels"
     _value_class: Type[VideoRectangleValue] = VideoRectangleValue
-
+    
+    
+class NumberValue(BaseModel):
+    number: int = Field(..., ge=0)
+    
 
 class NumberTag(ControlTag):
     """ """
+    _value_class: Type[NumberValue] = NumberValue
+    
 
-    def validate_value(self, value) -> bool:
-        """ """
-        # TODO implement
-        return True
-
-    def label(self, *args, **kwargs):
-        """ """
-
+class DateTimeValue(BaseModel):
+    datetime: str
 
+    
 class DateTimeTag(ControlTag):
     """ """
-
-    def validate_value(self, value) -> bool:
-        """ """
-        # TODO implement
-        return True
-
-    def label(self, *args, **kwargs):
-        """ """
+    _value_class: Type[DateTimeValue] = DateTimeValue
 
 
 class HyperTextLabelsValue(SpanSelectionOffsets):
@@ -669,8 +705,10 @@ class PairwiseTag(ControlTag):
 
     _value_class: Type[PairwiseValue] = PairwiseValue
 
-    def label(self, *args, **kwargs):
+    def label(self, side):
         """ """
+        value = PairwiseValue(selected=side)
+        return Region(from_tag=self, to_tag=self, value=value)
 
 
 class ParagraphLabelsValue(SpanSelectionOffsets):
@@ -683,46 +721,46 @@ class ParagraphLabelsTag(ControlTag):
     _label_attr_name: str = "paragraphlabels"
     _value_class: Type[ParagraphLabelsValue] = ParagraphLabelsValue
 
-    def label(self, *args, **kwargs):
+    def label(self, utterance=None, *args, **kwargs):
         """ """
+        if isinstance(utterance, int):
+            kwargs["start"] = utterance
+            kwargs["end"] = utterance
+
+        return super().label(*args, **kwargs)
+        
 
+class RankerValue(BaseModel):
+    rank: List[str]
 
+    
 class RankerTag(ControlTag):
     """ """
-
-    def validate_value(self, value) -> bool:
-        """ """
-        # TODO
-        return True
-
-    def label(self, *args, **kwargs):
-        """ """
+    _value_class: Type[RankerValue] = RankerValue
 
 
 class RatingValue(BaseModel):
-    rating: int
+    rating: int = Field(..., ge=0)
 
 
 class RatingTag(ControlTag):
     """ """
-
     _value_class: Type[RatingValue] = RatingValue
 
-    def label(self, *args, **kwargs):
-        """ """
-
 
 class RelationsTag(ControlTag):
     """ """
-
-    def validate_value(self, value) -> bool:
+    def validate_value(self, ) -> bool:
         """ """
-        # TODO
-        return True
+        raise NotImplemented("""Should not be called directly, instead
+        use validate_relation() method found in LabelInterface class""")
 
     def label(self, *args, **kwargs):
         """ """
-
+        raise NotImplemented("""
+        Relations work on regions instead of Object tags
+        use Regions add_relation() method""")
+        
 
 class TaxonomyValue(BaseModel):
     taxonomy: List[List[str]]