class Classifications(ImageLabel):
"""A list of classifications (typically from a multilabel model) for an
image sample in a :class:`fiftyone.core.dataset.Dataset`.
Args:
classifications (None): a list of :class:`Classification` instances
"""
meta = {"allow_inheritance": True}
classifications = fof.ListField(fof.EmbeddedDocumentField(Classification))
logits = fof.VectorField()
def to_image_labels(self, name=None):
"""Returns an ``eta.core.image.ImageLabels`` representation of this
instance.
Args:
name (None): the name of the label field
Returns:
an ``eta.core.image.ImageLabels``
"""
image_labels = etai.ImageLabels()
# pylint: disable=not-an-iterable
for classification in self.classifications:
image_labels.add_attribute(
etad.CategoricalAttribute(
name,
classification.label,
confidence=classification.confidence,
))
return image_labels
class Classifications(ImageLabel):
"""A list of classifications (typically from a multilabel model) for an
image sample in a :class:`fiftyone.core.dataset.Dataset`.
Args:
classifications (None): a list of :class:`Classification` instances
"""
meta = {"allow_inheritance": True}
classifications = fof.ListField(fof.EmbeddedDocumentField(Classification))
logits = fof.VectorField()
def to_image_labels(self, name=None):
"""Returns an ``eta.core.image.ImageLabels`` representation of this
instance.
Args:
name (None): the name of the label field
Returns:
an ``eta.core.image.ImageLabels``
"""
image_labels = etai.ImageLabels()
# pylint: disable=not-an-iterable
for classification in self.classifications:
image_labels.add_attribute(
etad.CategoricalAttribute(
name,
classification.label,
confidence=classification.confidence,
)
)
return image_labels
@classmethod
def from_attributes(cls, attrs, skip_non_categorical=False):
"""Creates a :class:`Classifications` instance from a list of
attributes.
Args:
attrs: an iterable of :class:`Attribute` or
``eta.core.data.Attribute`` instances
skip_non_categorical (False): whether to skip non-categorical
attributes (True) or cast all attribute values to strings
(False)
Returns:
a :class:`Classifications`
"""
classifications = []
for attr in attrs:
if skip_non_categorical and not etau.is_str(attr.value):
continue
classifications.append(Classification.from_attribute(attr))
return cls(classifications=classifications)
class VectorAttribute(Attribute):
"""A vector attribute.
Args:
value (None): the attribute value
"""
value = fof.VectorField()
class CategoricalAttribute(Attribute):
"""A categorical attribute.
Args:
value (None): the attribute value
confidence (None): a confidence in ``[0, 1]`` for the value
logits (None): logits associated with the attribute
"""
value = fof.StringField()
confidence = fof.FloatField()
logits = fof.VectorField()
class Classification(ImageLabel, _HasID):
"""A classification label.
Args:
label (None): the label string
confidence (None): a confidence in ``[0, 1]`` for the label
logits (None): logits associated with the labels
"""
meta = {"allow_inheritance": True}
label = fof.StringField()
confidence = fof.FloatField()
logits = fof.VectorField()
def to_image_labels(self, name=None):
"""Returns an ``eta.core.image.ImageLabels`` representation of this
instance.
Args:
name (None): the name of the label field
Returns:
an ``eta.core.image.ImageLabels``
"""
image_labels = etai.ImageLabels()
image_labels.add_attribute(
etad.CategoricalAttribute(name,
self.label,
confidence=self.confidence))
return image_labels
@classmethod
def from_attribute(cls, attr):
"""Creates a :class:`Classification` instance from an attribute.
The attribute value is cast to a string, if necessary.
Args:
attr: an :class:`Attribute` or ``eta.core.data.Attribute``
Returns:
a :class:`Classification`
"""
classification = cls(label=str(attr.value))
try:
classification.confidence = attr.confidence
except:
pass
return classification
class Classification(ImageLabel):
"""A classification label.
Args:
label (None): the label string
confidence (None): a confidence in ``[0, 1]`` for the label
logits (None): logits associated with the labels
"""
meta = {"allow_inheritance": True}
_id = fof.ObjectIdField(required=True,
default=ObjectId,
unique=True,
primary_key=True)
label = fof.StringField()
confidence = fof.FloatField()
logits = fof.VectorField()
@property
def id(self):
"""The ID of the document."""
return str(self._id)
def to_image_labels(self, name=None):
"""Returns an ``eta.core.image.ImageLabels`` representation of this
instance.
Args:
name (None): the name of the label field
Returns:
an ``eta.core.image.ImageLabels``
"""
image_labels = etai.ImageLabels()
image_labels.add_attribute(
etad.CategoricalAttribute(name,
self.label,
confidence=self.confidence))
return image_labels
def _get_repr_fields(self):
# pylint: disable=no-member
return ("id", ) + self._fields_ordered
class Classification(ImageLabel):
"""A classification label.
Args:
label (None): the label string
confidence (None): a confidence in ``[0, 1]`` for the label
logits (None): logits associated with the labels
"""
meta = {"allow_inheritance": True}
_id = fof.ObjectIdField(
required=True, default=ObjectId, unique=True, primary_key=True
)
label = fof.StringField()
confidence = fof.FloatField()
logits = fof.VectorField()
@property
def id(self):
"""The ID of the document."""
return str(self._id)
def to_image_labels(self, name=None):
"""Returns an ``eta.core.image.ImageLabels`` representation of this
instance.
Args:
name (None): the name of the label field
Returns:
an ``eta.core.image.ImageLabels``
"""
image_labels = etai.ImageLabels()
image_labels.add_attribute(
etad.CategoricalAttribute(
name, self.label, confidence=self.confidence
)
)
return image_labels
@classmethod
def from_attribute(cls, attr):
"""Creates a :class:`Classification` instance from an attribute.
The attribute value is cast to a string, if necessary.
Args:
attr: an :class:`Attribute` or ``eta.core.data.Attribute``
Returns:
a :class:`Classification`
"""
classification = cls(label=str(attr.value))
try:
classification.confidence = attr.confidence
except:
pass
return classification
def _get_repr_fields(self):
# pylint: disable=no-member
return ("id",) + self._fields_ordered
class Detection(ImageLabel):
"""An object detection.
Args:
label (None): the label string
bounding_box (None): a list of relative bounding box coordinates in
``[0, 1]`` in the following format::
[<top-left-x>, <top-left-y>, <width>, <height>]
confidence (None): a confidence in ``[0, 1]`` for the label
attributes ({}): a dict mapping attribute names to :class:`Attribute`
instances
"""
meta = {"allow_inheritance": True}
_id = fof.ObjectIdField(required=True,
default=ObjectId,
unique=True,
primary_key=True)
label = fof.StringField()
bounding_box = fof.VectorField()
confidence = fof.FloatField()
attributes = fof.DictField(fof.EmbeddedDocumentField(Attribute))
@property
def id(self):
"""The ID of the document."""
return str(self._id)
def has_attribute(self, name):
"""Determines whether the detection has an attribute with the given
name.
Args:
name: the attribute name
Returns:
True/False
"""
# pylint: disable=unsupported-membership-test
return name in self.attributes
def get_attribute_value(self, name, default=no_default):
"""Gets the value of the attribute with the given name.
Args:
name: the attribute name
default (no_default): the default value to return if the attribute
does not exist. Can be ``None``. If no default value is
provided, an exception is raised if the attribute does not
exist
Returns:
the attribute value
Raises:
KeyError: if the attribute does not exist and no default value was
provided
"""
try:
# pylint: disable=unsubscriptable-object
return self.attributes[name].value
except KeyError:
if default is not no_default:
return default
raise
def to_detected_object(self, name=None):
"""Returns an ``eta.core.objects.DetectedObject`` representation of
this instance.
Args:
name (None): the name of the label field
Returns:
an ``eta.core.objects.DetectedObject``
"""
label = self.label
# pylint: disable=unpacking-non-sequence
tlx, tly, w, h = self.bounding_box
brx = tlx + w
bry = tly + h
bounding_box = etag.BoundingBox.from_coords(tlx, tly, brx, bry)
confidence = self.confidence
# pylint: disable=no-member
attrs = etad.AttributeContainer()
for attr_name, attr in self.attributes.items():
attrs.add(etad.CategoricalAttribute(attr_name, attr.value))
return etao.DetectedObject(
label=label,
bounding_box=bounding_box,
confidence=confidence,
name=name,
attrs=attrs,
)
def to_image_labels(self, name=None):
"""Returns an ``eta.core.image.ImageLabels`` representation of this
instance.
Args:
name (None): the name of the label field
Returns:
an ``eta.core.image.ImageLabels``
"""
image_labels = etai.ImageLabels()
image_labels.add_object(self.to_detected_object(name=name))
return image_labels
def _get_repr_fields(self):
# pylint: disable=no-member
return ("id", ) + self._fields_ordered