label-studio-sdk 0.0.34__py3-none-any.whl → 1.0.1__py3-none-any.whl

label_studio_sdk/label_interface/data_examples.json

@@ -0,0 +1,96 @@
+{
+  "editor_preview": {
+    "TextRaw": "To have faith is to trust yourself to the water",
+    "TextUrl": "https://htx-pub.s3.amazonaws.com/example.txt",
+    "HyperText": "<div style=\"max-width: 750px\"><div style=\"clear: both\"><div style=\"float: right; display: inline-block; border: 1px solid #F2F3F4; background-color: #F8F9F9; border-radius: 5px; padding: 7px; margin: 10px 0;\"><p><b>Jules<\/b>: No no, Mr. Wolfe, it's not like that. Your help is definitely appreciated.<\/p><\/div><\/div><div style=\"clear: both\"><div style=\"float: right; display: inline-block; border: 1px solid #F2F3F4; background-color: #F8F9F9; border-radius: 5px; padding: 7px; margin: 10px 0;\"><p><b>Vincent<\/b>: Look, Mr. Wolfe, I respect you. I just don't like people barking orders at me, that's all.<\/p><\/div><\/div><div style=\"clear: both\"><div style=\"display: inline-block; border: 1px solid #D5F5E3; background-color: #EAFAF1; border-radius: 5px; padding: 7px; margin: 10px 0;\"><p><b>The Wolf<\/b>: If I'm curt with you, it's because time is a factor. I think fast, I talk fast, and I need you two guys to act fast if you want to get out of this. So pretty please, with sugar on top, clean the car.<\/p><\/div><\/div><\/div>",
+    "HyperTextUrl": "<HOSTNAME>/static/samples/hypertext.html",
+    "Image": "<HOSTNAME>/static/samples/sample.jpg",
+    "Audio": "<HOSTNAME>/static/samples/game.wav",
+    "AudioPlus": "<HOSTNAME>/static/samples/game.wav",
+    "Header": "Task header",
+    "Paragraphs":  [{"author": "Alice", "text": "Hi, Bob."}, {"author": "Bob", "text": "Hello, Alice!"}, {"author": "Alice", "text": "What's up?"}, {"author": "Bob", "text": "Good. Ciao!"}, {"author": "Alice", "text": "Bye, Bob."}],
+    "ParagraphsUrl": "<HOSTNAME>/samples/paragraphs.json?",
+    "Table": {"Card number": 18799210, "First name": "Max", "Last name":  "Nobel"},
+    "$videoHack": "<video src='<HOSTNAME>/static/samples/opossum_snow.mp4' width=100% controls>",
+    "Video": "<HOSTNAME>/static/samples/opossum_snow.mp4",
+    "Labels": [
+      { "value": "DynamicLabel1", "background": "#ff0000" },
+      { "value": "DynamicLabel2", "background": "#0000ff" }
+    ],
+    "Choices": [
+      { "value": "DynamicChoice1" },
+      { "value": "DynamicChoice2" },
+      { "value": "DynamicChoice3" }
+    ],
+    "NestedChoices": [
+      {
+        "value": "DynamicChoiceHeader1",
+        "children": [
+          { "value": "DynamicChoice1.1" },
+          { "value": "DynamicChoice1.2" }
+        ]
+      },
+      {
+        "value": "DynamicChoiceHeader2",
+        "children": [
+          { "value": "DynamicChoice2.1" },
+          { "value": "DynamicChoice2.2" },
+          { "value": "DynamicChoice2.3" }
+        ]
+      }
+    ],
+    "List": [
+      {
+        "id": 1,
+        "title": "The Amazing World of Opossums",
+        "body": "Opossums are fascinating marsupials native to North America. They have prehensile tails, which help them to climb trees and navigate their surroundings with ease. Additionally, they are known for their unique defense mechanism, called 'playing possum,' where they mimic the appearance and smell of a dead animal to deter predators."
+      },
+      {
+        "id": 2,
+        "title": "Opossums: Nature's Pest Control",
+        "body": "Opossums play a crucial role in controlling insect and rodent populations, as they consume a variety of pests like cockroaches, beetles, and mice. This makes them valuable allies for gardeners and homeowners, as they help to maintain a balanced ecosystem and reduce the need for chemical pest control methods."
+      },
+      {
+        "id": 3,
+        "title": "Fun Fact: Opossums Are Immune to Snake Venom",
+        "body": "One surprising characteristic of opossums is their natural immunity to snake venom. They have a unique protein in their blood called 'Lethal Toxin-Neutralizing Factor' (LTNF), which neutralizes venom from a variety of snake species, including rattlesnakes and cottonmouths. This allows opossums to prey on snakes without fear of harm, further highlighting their important role in the ecosystem."
+      }
+    ],
+    "$longText": "Opossums are frequently considered to be living fossils, and as a result are often used to approximate the ancestral therian condition in comparative studies. However, this is inaccurate, the oldest opossum fossils are early Miocene in age (roughly 20 million years old) and the last common ancestor of all living opossums approximately dates to the Oligocene-Miocene boundary (roughly 23 million years ago) and is at most no older than Oligocene in age. Many extinct metatherians once considered early opossums, such as Alphadon, Peradectes, Herpetotherium, and Pucadelphys, have since been recognized to have been previously grouped with opossums on the basis of plesiomorphies and are now considered to represent older branches of Metatheria only distantly related to modern opossums.",
+    "$corefText": "I voted for Obama because he was most aligned with my values, she said.",
+    "$pdf": "<embed src='<HOSTNAME>/static/samples/sample.pdf' width='100%' height='600px'/>",
+    "$website": "<iframe src='http://heartex.ai' width='100%' height='600px'/>",
+    "$headlessCsv": "<HOSTNAME>/static/samples/sample-task-sin-headless.csv",
+    "$humanMachineDialogue": [
+        {"author": "Human", "text": "Hi, Robot!"},
+        {"author": "Robot", "text": "Nice to meet you, man! Tell me what you want."},
+        {"author": "Human", "text": "Order me a pizza from Golden Boy at Green Street "},
+        {"author": "Robot", "text": "Done. When do you want to get the order?"},
+        {"author": "Human", "text": "At 3am in the morning, please"}],
+    "$respone": "Sure, no problem!",
+    "$resptwo": "Sorry, it's too early. May be we can change the time?",
+    "$respthree": "Don't eat junk food man, it's bad for you...",
+    "$ocr": "https://htx-pub.s3.amazonaws.com/demo/ocr/example.jpg",
+    "$ner": "A Florida restaurant paid 10,925 pounds ($16,935) for the draft of \\\"Ain't no telling\\\", which Hendrix penned on a piece of London hotel stationery in late 1966.",
+    "$captioning": "<HOSTNAME>/static/samples/trees_in_snow.jpg",
+    "$pairText1": "Look at this! It's a brand new product",
+    "$pairText2": "Look at this! It's an awesome piece of sh*t"
+  },
+  "upload": {
+    "TextRaw": "To have faith is to trust yourself to the water",
+    "TextUrl": "https://htx-pub.s3.amazonaws.com/example.txt",
+    "HyperText": "<a href='heartex.net'>Heartex</a>",
+    "Image": "<HOSTNAME>/static/samples/sample.jpg",
+    "Audio": "<HOSTNAME>/static/samples/game.wav",
+    "AudioPlus": "<HOSTNAME>/static/samples/game.wav",
+    "Header": "Task header",
+    "Paragraphs":  [{"author": "Alice", "text": "Hi, Bob."}, {"author": "Bob", "text": "Hello, Alice!"}, {"author": "Alice", "text": "What's up?"}, {"author": "Bob", "text": "Good. Ciao!"}, {"author": "Alice", "text": "Bye, Bob."}],
+    "Table": {"Card number": 18799210, "First name": "Max", "Last name":  "Nobel"},
+    "$videoHack": "<video src='static/samples/opossum_snow.mp4' width=100% controls>",
+    "Video": "<HOSTNAME>/static/samples/opossum_snow.mp4",
+    "$longText": "Opossums are frequently considered to be living fossils, and as a result are often used to approximate the ancestral therian condition in comparative studies. However, this is inaccurate, the oldest opossum fossils are early Miocene in age (roughly 20 million years old) and the last common ancestor of all living opossums approximately dates to the Oligocene-Miocene boundary (roughly 23 million years ago) and is at most no older than Oligocene in age. Many extinct metatherians once considered early opossums, such as Alphadon, Peradectes, Herpetotherium, and Pucadelphys, have since been recognized to have been previously grouped with opossums on the basis of plesiomorphies and are now considered to represent older branches of Metatheria only distantly related to modern opossums.",
+    "$pdf": "<embed src='<HOSTNAME>/static/samples/sample.pdf' width='100%' height='600px'/>",
+    "$website": "<iframe src='https://heartex.ai' width='100%' height='600px'/>",
+    "$headlessCsv": "<HOSTNAME>/static/samples/sample-task-sin-headless.csv"
+  }
+}

label_studio_sdk/label_interface/interface.py

@@ -12,28 +12,28 @@ from typing import Dict, Optional, List, Tuple, Any, Callable, Union
 from pydantic import BaseModel
 
 # from typing import Dict, Optional, List, Tuple, Any
-from collections import defaultdict
+from collections import defaultdict, OrderedDict
 from lxml import etree
 import xmljson
 
-from label_studio_sdk.exceptions import (
+from label_studio_sdk._legacy.exceptions import (
     LSConfigParseException,
     LabelStudioXMLSyntaxErrorSentryIgnored,
     LabelStudioValidationErrorSentryIgnored,
 )
 
-from label_studio_sdk.label_interface.control_tags import (
+from .control_tags import (
     ControlTag,
     ChoicesTag,
     LabelsTag,
 )
-from label_studio_sdk.label_interface.object_tags import ObjectTag
-from label_studio_sdk.label_interface.label_tags import LabelTag
-from label_studio_sdk.objects import AnnotationValue, TaskValue, PredictionValue
+from .object_tags import ObjectTag
+from .label_tags import LabelTag
+from label_studio_sdk._legacy.objects import AnnotationValue, TaskValue, PredictionValue
 
 
 dir_path = os.path.dirname(os.path.realpath(__file__))
-file_path = os.path.join(dir_path, "..", "schema", "label_config_schema.json")
+file_path = os.path.join(dir_path, "..", "_legacy", "schema", "label_config_schema.json")
 
 with open(file_path) as f:
     _LABEL_CONFIG_SCHEMA_DATA = json.load(f)
@@ -189,23 +189,34 @@ class LabelInterface:
     ```
     """
 
-    def __init__(self, config: str, *args, **kwargs):
+    def __init__(self, config: str, tags_mapping=None, *args, **kwargs):
         """
-        Create LabelInterface instance from the config string
-        Example:
+        Initialize a LabelInterface instance using a config string.
+
+        Args:
+          config (str): Configuration string.
+          tags_mapping: Provide your own implementation of any tag, this is helpful in cases where you want to override one of the control tags, and have your custom .label() method implemented.
+
+        The configuration string should be formatted as follows:
+
         ```
-        label_config = LabelInterface('''
         <View>
-        <Choices name="sentiment" toName="txt">
+          <Choices name="sentiment" toName="txt">
             <Choice value="Positive" />
             <Choice value="Negative" />
             <Choice value="Neutral" />
-        </Choices>
-        <Text name="txt" value="$text" />
-        ''')
+          </Choices>
+          <Text name="txt" value="$text" />
+        </View>
+        ```
+        This method will extract the predefined task from the configuration and 
+        parse the controls, objects, and labels used in it.
         """
+        self.task_loaded = False
+        
         self._config = config
-
+        self._tags_mapping = tags_mapping
+        
         # extract predefined task from the config
         _task_data, _ann, _pred = LabelInterface.get_task_from_labeling_config(config)
         self._sample_config_task = _task_data
@@ -225,6 +236,8 @@ class LabelInterface:
         self._labels = labels
         self._tree = tree
 
+        
+
     ##### NEW API
 
     @property
@@ -391,7 +404,38 @@ class LabelInterface:
             lst = list(filter(match_fn, lst))
 
         return lst
+    
+    def load_task(self, task):
+        """Loads a task and substitutes the value in each object tag
+        with actual data from the task, returning a copy of the
+        LabelConfig object.
+
+        If the `value` field in an object tag is designed to take
+        variable input (i.e., `value_is_variable` is True), the
+        function replaces this value with the corresponding value from
+        the task dictionary.
+
+        Args:
+            task (dict): Dictionary representing the task, where
+            each key-value pair denotes an attribute-value of the
+            task.
+
+        Returns:
+            LabelInterface: A deep copy of the current LabelIntreface
+            instance with the object tags' value fields populated with
+            data from the task.
+
+        """
+        tree = copy.deepcopy(self)
+        tree.task_loaded = True
+        
+        for obj in tree.objects:
+            print(obj.value_is_variable, obj.value_name)
+            if obj.value_is_variable and obj.value_name in task:
+                obj.value = task.get(obj.value_name)
 
+        return tree
+    
     def parse(self, config_string: str) -> Tuple[Dict, Dict, Dict, etree._Element]:
         """Parses the received configuration string into dictionaries
         of ControlTags, ObjectTags, and Labels, along with an XML tree
@@ -422,14 +466,17 @@ class LabelInterface:
                 variables.append(tag.attrib["indexFlag"])
 
             if ControlTag.validate_node(tag):
-                controls[tag.attrib["name"]] = ControlTag.parse_node(tag)
+                controls[tag.attrib["name"]] = ControlTag.parse_node(tag, tags_mapping=self._tags_mapping)
 
             elif ObjectTag.validate_node(tag):
-                objects[tag.attrib["name"]] = ObjectTag.parse_node(tag)
+                objects[tag.attrib["name"]] = ObjectTag.parse_node(tag, tags_mapping=self._tags_mapping)
 
             elif LabelTag.validate_node(tag):
                 lb = LabelTag.parse_node(tag, controls)
-                labels[lb.parent_name][lb.value] = lb
+                # This case is hit when Label tag is missing `value` and `alias`
+                # For now we will skip that Label, but in future might want to raise an error
+                if lb:
+                    labels[lb.parent_name][lb.value] = lb
 
         return controls, objects, labels, xml_tree
 
@@ -485,34 +532,6 @@ class LabelInterface:
                 "Label config contains non-unique names"
             )
 
-    def load_task(self, task):
-        """Loads a task and substitutes the value in each object tag
-        with actual data from the task, returning a copy of the
-        LabelConfig object.
-
-        If the `value` field in an object tag is designed to take
-        variable input (i.e., `value_is_variable` is True), the
-        function replaces this value with the corresponding value from
-        the task dictionary.
-
-        Args:
-            task (dict): Dictionary representing the task, where
-            each key-value pair denotes an attribute-value of the
-            task.
-
-        Returns:
-            LabelInterface: A deep copy of the current LabelIntreface
-            instance with the object tags' value fields populated with
-            data from the task.
-
-        """
-        tree = copy.deepcopy(self)
-        for obj in tree.objects:
-            if obj.value_is_variable and obj.value_name in task:
-                obj.value = task.get(obj.value_name)
-
-        return tree
-
     @property
     def is_valid(self):
         """ """
@@ -565,6 +584,23 @@ class LabelInterface:
 
         return True
 
+    def _validate_object(self, obj):
+        """ """
+        regions = []
+        for r in obj.get(RESULT_KEY):
+            if r.get('type') != "relation":
+                if not self.validate_region(r):
+                    return False
+
+                regions.append(r)
+
+        for r in obj.get(RESULT_KEY):
+            if r.get('type') == "relation" and \
+               not self.validate_relation(r, regions):
+                return False
+
+        return True                                                
+        
     def validate_annotation(self, annotation):
         """Validates the given annotation against the current configuration.
 
@@ -583,11 +619,11 @@ class LabelInterface:
             validation, False otherwise.
 
         """
-        return all(self.validate_region(r) for r in annotation.get(RESULT_KEY))
+        return self._validate_object(annotation)
 
     def validate_prediction(self, prediction):
         """Same as validate_annotation right now"""
-        return all(self.validate_region(r) for r in prediction.get(RESULT_KEY))
+        return self._validate_object(prediction)
 
     def validate_region(self, region) -> bool:
         """Validates a region from the annotation against the current
@@ -617,22 +653,35 @@ class LabelInterface:
         if not control or not obj:
             return False
 
-        # type of the region should match the tag name
+        # type of the region should match the tag name        
         if control.tag.lower() != region["type"]:
             return False
-
+        
         # make sure that in config it connects to the same tag as
         # immplied by the region data
         if region["to_name"] not in control.to_name:
             return False
-
+        
         # validate the actual value, for example that <Labels /> tag
         # is producing start, end, and labels
         if not control.validate_value(region["value"]):
             return False
-
+        
         return True
 
+    def validate_relation(self, relation, regions, _mapping=None) -> bool:
+        """Validates that the relation is correct and all the associated objects are provided"""
+        if _mapping is None:
+            _mapping = { r['id']: r for r in regions }
+
+        if relation.get("type") != "relation" or \
+           relation.get("direction") not in ("left", "right", "bi") or \
+           relation.get("from_id") not in _mapping or \
+           relation.get("to_id") not in _mapping:
+            return False
+        
+        return True
+    
     ### Generation
 
     def _sample_task(self, secure_mode=False):

label_studio_sdk/label_interface/object_tags.py

@@ -8,7 +8,7 @@ import xml.etree.ElementTree
 from urllib.parse import urlencode
 from typing import Optional
 
-from .base import LabelStudioTag
+from .base import LabelStudioTag, get_tag_class
 
 _TAG_TO_CLASS = {
     "audio": "AudioTag",
@@ -77,12 +77,6 @@ def data_examples(
     return _DATA_EXAMPLES[mode]
 
 
-def get_tag_class(name):
-    """ """
-    class_name = _TAG_TO_CLASS.get(name.lower())
-    return globals().get(class_name, None)
-
-
 class ObjectTag(LabelStudioTag):
     """
     Class that represents a ObjectTag in Label Studio
@@ -103,7 +97,7 @@ class ObjectTag(LabelStudioTag):
     # self._value_type = value_type
 
     @classmethod
-    def parse_node(cls, tag: xml.etree.ElementTree.Element) -> "ObjectTag":
+    def parse_node(cls, tag: xml.etree.ElementTree.Element, tags_mapping=None) -> "ObjectTag":
         """
         This class method parses a node and returns a ObjectTag object if the node has a name and a value.
 
@@ -117,8 +111,10 @@ class ObjectTag(LabelStudioTag):
         ObjectTag
             A new ObjectTag object with the tag name, attributes, name, and value.
         """
-        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)
+        
         return tag_class(
             tag=tag.tag,
             attr=dict(tag.attrib),
@@ -146,10 +142,9 @@ class ObjectTag(LabelStudioTag):
     @property
     def value_is_variable(self) -> bool:
         """Check if value has variable"""
-        pattern = re.compile(r"^\$[A-Za-z_]+$")
+        pattern = re.compile(r"^\$[^, ]+$")
         return bool(pattern.fullmatch(self.value))
-
-        # TODO this should not be here as soon as we cover all the tags
+    
 
     # and have generate_example in each
     def generate_example_value(self, mode="upload", secure_mode=False):

label_studio_sdk/label_interface/region.py

@@ -4,7 +4,7 @@
 import json
 from uuid import uuid4
 
-from typing import Any
+from typing import Any, List, Dict, Optional
 from pydantic import BaseModel, Field
 
 
@@ -26,6 +26,7 @@ class Region(BaseModel):
     from_tag: Any
     to_tag: Any
     value: Any
+    relations: Optional[List[Dict]] = []
 
     def _dict(self):
         """ """
@@ -38,6 +39,37 @@ class Region(BaseModel):
             "value": self.value.dict(),
         }
 
+    def _dict_relations(self):
+        """ """
+        # this code does not include "labels" key if no labels were passed
+        return [
+            {**{
+                "from_id": self.id,
+                "to_id": rel.get("region", {}).id,
+                "type": "relation",
+                "direction": rel.get("direction", "right")},
+             **({"labels": rel["labels"]} if rel.get("labels") else {})
+             }
+            for rel in self.relations
+        ]
+               
     def to_json(self):
         """ """
         return json.dumps(self._dict())
+
+    def to_json_relations(self):
+        """ """
+        return json.dumps(self._dict_relations())
+
+    @property
+    def has_relations(self):
+        return len(self.relations) > 0
+    
+    def add_relation(self, region=None, direction="right", label=None):
+        """ """
+        self.relations.append({ "region": region, "direction": direction, "labels": label })
+        
+    def set_relations(self, rels):
+        """ """
+        self.relations = rels
+        

label_studio_sdk/ml/__init__.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import (
+    MlCreateRequestAuthMethod,
+    MlCreateResponse,
+    MlCreateResponseAuthMethod,
+    MlUpdateRequestAuthMethod,
+    MlUpdateResponse,
+    MlUpdateResponseAuthMethod,
+)
+
+__all__ = [
+    "MlCreateRequestAuthMethod",
+    "MlCreateResponse",
+    "MlCreateResponseAuthMethod",
+    "MlUpdateRequestAuthMethod",
+    "MlUpdateResponse",
+    "MlUpdateResponseAuthMethod",
+]