Merge pull request #201 from Labelbox/ms/core-annotation-types

annotation types

Author: msokoloff1

.github/workflows/python-package.yml

@@ -47,13 +47,21 @@ jobs:
       uses: AlexanderMelde/yapf-action@master
       with:
         args: --verbose --recursive --parallel --style "google"
-
+    - name: dependencies
+      run: |
+        sudo apt-get -y update
+        sudo apt install -y libsm6 \
+                         libxext6 \
+                           ffmpeg \
+                   libfontconfig1 \
+                      libxrender1 \
+                  libgl1-mesa-glx
     - name: install labelbox package
       run: |
-        python setup.py install
+        python -m pip install --upgrade pip
+        python -m pip install .
     - name: mypy
       run: |
-        python -m pip install --upgrade pip
         pip install mypy==0.782
         mypy -p labelbox --pretty --show-error-codes
     - name: Install package and test dependencies

Dockerfile

@@ -1,11 +1,17 @@
 FROM python:3.7
 
 RUN pip install pytest pytest-cases
+RUN apt-get -y update
+RUN apt install -y libsm6 \
+                libxext6 \
+                ffmpeg \
+                libfontconfig1 \
+                libxrender1 \
+                libgl1-mesa-glx
 
 WORKDIR /usr/src/labelbox
 COPY requirements.txt /usr/src/labelbox
 RUN pip install -r requirements.txt
 COPY . /usr/src/labelbox
 
-
 RUN python setup.py install

labelbox/__init__.py

@@ -16,6 +16,6 @@
 from labelbox.schema.asset_attachment import AssetAttachment
 from labelbox.schema.webhook import Webhook
 from labelbox.schema.prediction import Prediction, PredictionModel
-from labelbox.schema.ontology import Ontology
+from labelbox.schema.ontology import Ontology, OntologyBuilder, Classification, Option, Tool
 from labelbox.schema.role import Role, ProjectRole
 from labelbox.schema.invite import Invite, InviteLimit

labelbox/data/__init__.py

@@ -0,0 +1,28 @@
+from .geometry import Line
+from .geometry import Point
+from .geometry import Mask
+from .geometry import Polygon
+from .geometry import Rectangle
+from .geometry import Geometry
+
+from .annotation import ClassificationAnnotation
+from .annotation import VideoClassificationAnnotation
+from .annotation import ObjectAnnotation
+from .annotation import VideoObjectAnnotation
+
+from .ner import TextEntity
+
+from .classification import Checklist
+from .classification import ClassificationAnswer
+from .classification import Dropdown
+from .classification import Radio
+from .classification import Text
+
+from .data import RasterData
+from .data import TextData
+from .data import VideoData
+
+from .label import Label
+
+from .collection import LabelList
+from .collection import LabelGenerator

labelbox/data/annotation_types/__init__.py

@@ -0,0 +1,47 @@
+from typing import Any, Dict, List, Union
+
+from .classification import Checklist, Dropdown, Radio, Text
+from .feature import FeatureSchema
+from .geometry import Geometry
+from .ner import TextEntity
+
+
+class BaseAnnotation(FeatureSchema):
+    """ Base annotation class. Shouldn't be directly instantiated
+    """
+
+    extra: Dict[str, Any] = {}
+
+
+class ClassificationAnnotation(BaseAnnotation):
+    """Class representing classification annotations (annotations that don't have a location) """
+    value: Union[Text, Checklist, Radio, Dropdown]
+
+
+class ObjectAnnotation(BaseAnnotation):
+    """Class representing objects annotations (non classifications or annotations that have a location)
+    """
+    value: Union[TextEntity, Geometry]
+    classifications: List[ClassificationAnnotation] = []
+
+
+class VideoObjectAnnotation(ObjectAnnotation):
+    """
+    Class for video objects annotations
+
+    Args:
+        frame: The frame index that this annotation corresponds to
+        keyframe: Whether or not this annotation was a human generated or interpolated annotation
+    """
+    frame: int
+    keyframe: bool
+
+
+class VideoClassificationAnnotation(ClassificationAnnotation):
+    """
+    Class for video classification annotations
+
+    Args:
+        frame: The frame index that this annotation corresponds to
+    """
+    frame: int

labelbox/data/annotation_types/annotation.py

@@ -0,0 +1,2 @@
+from .classification import (Checklist, ClassificationAnswer, Dropdown, Radio,
+                             Text)

labelbox/data/annotation_types/classification/__init__.py

@@ -0,0 +1,37 @@
+from typing import Any, Dict, List
+
+from pydantic.main import BaseModel
+
+from ..feature import FeatureSchema
+
+
+class ClassificationAnswer(FeatureSchema):
+    """
+    - Represents a classification option.
+    - Because it inherits from FeatureSchema
+        the option can be represented with either the name or schema_id
+    """
+    extra: Dict[str, Any] = {}
+
+
+class Radio(BaseModel):
+    """ A classification with only one selected option allowed """
+    answer: ClassificationAnswer
+
+
+class Checklist(BaseModel):
+    """ A classification with many selected options allowed """
+    answer: List[ClassificationAnswer]
+
+
+class Text(BaseModel):
+    """ Free form text """
+    answer: str
+
+
+class Dropdown(BaseModel):
+    """
+    - A classification with many selected options allowed .
+    - This is not currently compatible with MAL.
+    """
+    answer: List[ClassificationAnswer]