adding created_at and last_modified_at fields

voxel51 · Jul 26, 2024 · 2bf6843 · 2bf6843
1 parent 53c4466
commit 2bf6843
Show file tree

Hide file tree

Showing 37 changed files with 4,080 additions and 662 deletions.
diff --git a/docs/source/cheat_sheets/views_cheat_sheet.rst b/docs/source/cheat_sheets/views_cheat_sheet.rst
@@ -436,12 +436,14 @@ detection dataset:
     Media type:  image
     Num patches: 1232
     Patch fields:
-        id:           fiftyone.core.fields.ObjectIdField
-        filepath:     fiftyone.core.fields.StringField
-        tags:         fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
-        metadata:     fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.ImageMetadata)
-        sample_id:    fiftyone.core.fields.ObjectIdField
-        ground_truth: fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detection)
+        id:               fiftyone.core.fields.ObjectIdField
+        sample_id:        fiftyone.core.fields.ObjectIdField
+        filepath:         fiftyone.core.fields.StringField
+        tags:             fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
+        metadata:         fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.ImageMetadata)
+        created_at:       fiftyone.core.fields.DateTimeField
+        last_modified_at: fiftyone.core.fields.DateTimeField
+        ground_truth:     fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detection)
     View stages:
         1. ToPatches(field='ground_truth', config=None)
 
@@ -480,16 +482,18 @@ sample for each true positive, false positive, and false negative example.
     Media type:  image
     Num patches: 5363
     Patch fields:
-        id:           fiftyone.core.fields.ObjectIdField
-        filepath:     fiftyone.core.fields.StringField
-        tags:         fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
-        metadata:     fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.ImageMetadata)
-        predictions:  fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
-        ground_truth: fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
-        sample_id:    fiftyone.core.fields.ObjectIdField
-        type:         fiftyone.core.fields.StringField
-        iou:          fiftyone.core.fields.FloatField
-        crowd:        fiftyone.core.fields.BooleanField
+        id:               fiftyone.core.fields.ObjectIdField
+        sample_id:        fiftyone.core.fields.ObjectIdField
+        filepath:         fiftyone.core.fields.StringField
+        tags:             fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
+        metadata:         fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.ImageMetadata)
+        created_at:       fiftyone.core.fields.DateTimeField
+        last_modified_at: fiftyone.core.fields.DateTimeField
+        predictions:      fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
+        ground_truth:     fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
+        type:             fiftyone.core.fields.StringField
+        iou:              fiftyone.core.fields.FloatField
+        crowd:            fiftyone.core.fields.BooleanField
     View stages:
         1. ToEvaluationPatches(eval_key='eval', config=None)
 
@@ -525,16 +529,20 @@ by a specific field or expression in a video collection.
    Media type: video
    Num clips:  11
    Clip fields:
-       id:        fiftyone.core.fields.ObjectIdField
-       sample_id: fiftyone.core.fields.ObjectIdField
-       filepath:  fiftyone.core.fields.StringField
-       support:   fiftyone.core.fields.FrameSupportField
-       tags:      fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
-       metadata:  fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.VideoMetadata)
+       id:               fiftyone.core.fields.ObjectIdField
+       sample_id:        fiftyone.core.fields.ObjectIdField
+       filepath:         fiftyone.core.fields.StringField
+       support:          fiftyone.core.fields.FrameSupportField
+       tags:             fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
+       metadata:         fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.VideoMetadata)
+       created_at:       fiftyone.core.fields.DateTimeField
+       last_modified_at: fiftyone.core.fields.DateTimeField
    Frame fields:
-       id:           fiftyone.core.fields.ObjectIdField
-       frame_number: fiftyone.core.fields.FrameNumberField
-       detections:   fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
+       id:               fiftyone.core.fields.ObjectIdField
+       frame_number:     fiftyone.core.fields.FrameNumberField
+       created_at:       fiftyone.core.fields.DateTimeField
+       last_modified_at: fiftyone.core.fields.DateTimeField
+       detections:       fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
    View stages:
        1. FilterLabels(field='frames.detections', ...)
        2. ToClips(field_or_expr='frames.detections', config=None)
@@ -565,13 +573,15 @@ frame in the input collection.
    Media type:  image
    Num samples: 1279
    Sample fields:
-      id:           fiftyone.core.fields.ObjectIdField
-      filepath:     fiftyone.core.fields.StringField
-      tags:         fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
-      metadata:     fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.ImageMetadata)
-      sample_id:    fiftyone.core.fields.ObjectIdField
-      frame_number: fiftyone.core.fields.FrameNumberField
-      detections:   fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
+      id:               fiftyone.core.fields.ObjectIdField
+      sample_id:        fiftyone.core.fields.ObjectIdField
+      frame_number:     fiftyone.core.fields.FrameNumberField
+      filepath:         fiftyone.core.fields.StringField
+      tags:             fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
+      metadata:         fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.ImageMetadata)
+      created_at:       fiftyone.core.fields.DateTimeField
+      last_modified_at: fiftyone.core.fields.DateTimeField
+      detections:       fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
    View stages:
      1. ToFrames(config=None)
 
@@ -604,11 +614,14 @@ For example, the following code creates an image collection from the "left" and
     Media type:  image
     Num samples: 400
     Sample fields:
-        id:       fiftyone.core.fields.ObjectIdField
-        filepath: fiftyone.core.fields.StringField
-        tags:     fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
-        metadata: fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.Metadata)
-        group:    fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.groups.Group)
+        id:               fiftyone.core.fields.ObjectIdField
+        filepath:         fiftyone.core.fields.StringField
+        tags:             fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
+        metadata:         fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.Metadata)
+        created_at:       fiftyone.core.fields.DateTimeField
+        last_modified_at: fiftyone.core.fields.DateTimeField
+        group:            fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.groups.Group)
+        ground_truth:     fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
     View stages:
         1. SelectGroupSlices(slices=['left', 'right'])
 

diff --git a/docs/source/integrations/coco.rst b/docs/source/integrations/coco.rst
@@ -284,12 +284,14 @@ dataset:
     Persistent:  False
     Tags:        []
     Sample fields:
-        id:         fiftyone.core.fields.ObjectIdField
-        filepath:   fiftyone.core.fields.StringField
-        tags:       fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
-        metadata:   fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.ImageMetadata)
-        detections: fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
-        coco_id:    fiftyone.core.fields.IntField
+        id:               fiftyone.core.fields.ObjectIdField
+        filepath:         fiftyone.core.fields.StringField
+        tags:             fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
+        metadata:         fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.ImageMetadata)
+        created_at:       fiftyone.core.fields.DateTimeField
+        last_modified_at: fiftyone.core.fields.DateTimeField
+        detections:       fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
+        coco_id:          fiftyone.core.fields.IntField
 
 In the above call to
 :meth:`Dataset.from_dir() <fiftyone.core.dataset.Dataset.from_dir>`, we provide

diff --git a/docs/source/user_guide/app.rst b/docs/source/user_guide/app.rst
@@ -2443,14 +2443,16 @@ store their paths in a `thumbnail_path` field:
     Persistent:  False
     Tags:        []
     Sample fields:
-        id:             fiftyone.core.fields.ObjectIdField
-        filepath:       fiftyone.core.fields.StringField
-        tags:           fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
-        metadata:       fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.ImageMetadata)
-        ground_truth:   fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
-        uniqueness:     fiftyone.core.fields.FloatField
-        predictions:    fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
-        thumbnail_path: fiftyone.core.fields.StringField
+        id:               fiftyone.core.fields.ObjectIdField
+        filepath:         fiftyone.core.fields.StringField
+        tags:             fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
+        metadata:         fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.ImageMetadata)
+        created_at:       fiftyone.core.fields.DateTimeField
+        last_modified_at: fiftyone.core.fields.DateTimeField
+        ground_truth:     fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
+        uniqueness:       fiftyone.core.fields.FloatField
+        predictions:      fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
+        thumbnail_path:   fiftyone.core.fields.StringField
 
 We can expose the thumbnail images to the App by modifying the
 :ref:`dataset's App config <dataset-app-config>`:

diff --git a/docs/source/user_guide/basics.rst b/docs/source/user_guide/basics.rst
@@ -77,10 +77,12 @@ obtain a desired subset of the samples.
     Persistent:     False
     Tags:           []
     Sample fields:
-        id:         fiftyone.core.fields.ObjectIdField
-        filepath:   fiftyone.core.fields.StringField
-        tags:       fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
-        metadata:   fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.Metadata)
+        id:               fiftyone.core.fields.ObjectIdField
+        filepath:         fiftyone.core.fields.StringField
+        tags:             fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
+        metadata:         fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.Metadata)
+        created_at:       fiftyone.core.fields.DateTimeField
+        last_modified_at: fiftyone.core.fields.DateTimeField
 
 .. _basics-samples:
 
@@ -120,7 +122,8 @@ about the samples. Thinking of a |Dataset| as a table where each row is a
 
 All samples must have their `filepath` field populated, which points to the
 source data for the sample on disk. By default, samples are also given `id`,
-`media_type`, `metadata`, and `tags` fields that store common information:
+`media_type`, `tags`, `metadata`, `created_at`, and `last_modified_at` fields
+that store common information:
 
 .. code-block:: python
     :linenos:
@@ -139,6 +142,8 @@ source data for the sample on disk. By default, samples are also given `id`,
         'filepath': 'path/to/image.png',
         'tags': [],
         'metadata': None,
+        'created_at': None,
+        'last_modified_at': None,
     }>
 
 Custom fields can contain any Python primitive data type:
@@ -194,13 +199,15 @@ schema and thus accessible on all other samples in the dataset.
     Persistent:     False
     Tags:           []
     Sample fields:
-        id:        fiftyone.core.fields.ObjectIdField
-        filepath:  fiftyone.core.fields.StringField
-        tags:      fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
-        metadata:  fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.ImageMetadata)
-        quality:   fiftyone.core.fields.FloatField
-        keypoints: fiftyone.core.fields.ListField
-        geo_json:  fiftyone.core.fields.DictField
+        id:               fiftyone.core.fields.ObjectIdField
+        filepath:         fiftyone.core.fields.StringField
+        tags:             fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
+        metadata:         fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.ImageMetadata)
+        created_at:       fiftyone.core.fields.DateTimeField
+        last_modified_at: fiftyone.core.fields.DateTimeField
+        quality:          fiftyone.core.fields.FloatField
+        keypoints:        fiftyone.core.fields.ListField
+        geo_json:         fiftyone.core.fields.DictField
 
 .. custombutton::
     :button_text: Learn more about sample fields
@@ -284,6 +291,8 @@ metadata about the source media of the sample.
             'height': 664,
             'num_channels': 3,
         }>,
+        'created_at': datetime.datetime(2024, 7, 22, 5, 16, 10, 701907),
+        'last_modified_at': datetime.datetime(2024, 7, 22, 5, 16, 10, 701907),
     }>
 
 .. _basics-labels:
@@ -350,6 +359,8 @@ Using FiftyOne's |Label| types enables you to visualize your labels in the
         'filepath': 'path/to/image.png',
         'tags': [],
         'metadata': None,
+        'created_at': None,
+        'last_modified_at': None,
         'weather': <Classification: {'label': 'sunny', 'confidence': None, 'logits': None}>,
         'animals': <Detections: {
             'detections': [

diff --git a/docs/source/user_guide/evaluation.rst b/docs/source/user_guide/evaluation.rst
@@ -1960,18 +1960,20 @@ You can also view frame-level evaluation results as
     Media type:  image
     Num patches: 12112
     Patch fields:
-        id:           fiftyone.core.fields.ObjectIdField
-        filepath:     fiftyone.core.fields.StringField
-        tags:         fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
-        metadata:     fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.ImageMetadata)
-        predictions:  fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
-        detections:   fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
-        sample_id:    fiftyone.core.fields.ObjectIdField
-        frame_id:     fiftyone.core.fields.ObjectIdField
-        frame_number: fiftyone.core.fields.FrameNumberField
-        type:         fiftyone.core.fields.StringField
-        iou:          fiftyone.core.fields.FloatField
-        crowd:        fiftyone.core.fields.BooleanField
+        id:               fiftyone.core.fields.ObjectIdField
+        sample_id:        fiftyone.core.fields.ObjectIdField
+        frame_id:         fiftyone.core.fields.ObjectIdField
+        filepath:         fiftyone.core.fields.StringField
+        frame_number:     fiftyone.core.fields.FrameNumberField
+        tags:             fiftyone.core.fields.ListField(fiftyone.core.fields.StringField)
+        metadata:         fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.metadata.ImageMetadata)
+        created_at:       fiftyone.core.fields.DateTimeField
+        last_modified_at: fiftyone.core.fields.DateTimeField
+        predictions:      fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
+        detections:       fiftyone.core.fields.EmbeddedDocumentField(fiftyone.core.labels.Detections)
+        type:             fiftyone.core.fields.StringField
+        iou:              fiftyone.core.fields.FloatField
+        crowd:            fiftyone.core.fields.BooleanField
     View stages:
         1. ToFrames(config=None)
         2. ToEvaluationPatches(eval_key='eval', config=None)