Document for geographic metadata (#349)

Author: jean-lucas

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to the [Nucleus Python Client](https://github.com/scaleapi/n
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.14.19](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.14.19) - 2022-08-26
+
+### Added
+- Support for Coordinate metadata values. See [upload metadata](https://nucleus.scale.com/docs/upload-metadata) for more information.
+
 ## [0.14.18](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.14.18) - 2022-08-16
 
 ### Added

nucleus/annotation.py

@@ -132,6 +132,10 @@ class BoxAnnotation(Annotation):  # pylint: disable=R0902
             attach to this annotation.  Strings, floats and ints are supported best
             by querying and insights features within Nucleus. For more details see
             our `metadata guide <https://nucleus.scale.com/docs/upload-metadata>`_.
+
+            Coordinate metadata may be provided to enable the Map Chart in the Nucleus Dataset charts page.
+            These values can be specified as `{"lat": 52.5, "lon": 13.3, ... }`.
+
         embedding_vector: Custom embedding vector for this object annotation.
             If any custom object embeddings have been uploaded previously to this dataset,
             this vector must match the dimensions of the previously ingested vectors.

nucleus/dataset_item.py

@@ -86,6 +86,9 @@ class DatasetItem:  # pylint: disable=R0902
           <https://nucleus.scale.com/docs/uploading-3d-data>`_ for more
           info.
 
+          Coordinate metadata may be provided to enable the Map Chart in the Nucleus Dataset charts page.
+          These values can be specified as `{"lat": 52.5, "lon": 13.3, ... }`.
+
           .. todo ::
               Shorten this once we have a guide migrated for metadata, or maybe link
               from other places to here.

nucleus/prediction.py

@@ -158,6 +158,10 @@ class BoxPrediction(BoxAnnotation):
             attach to this annotation.  Strings, floats and ints are supported best
             by querying and insights features within Nucleus. For more details see
             our `metadata guide <https://nucleus.scale.com/docs/upload-metadata>`_.
+
+            Coordinate metadata may be provided to enable the Map Chart in the Nucleus Dataset charts page.
+            These values can be specified as `{"lat": 52.5, "lon": 13.3, ... }`.
+
         class_pdf: An optional complete class probability distribution on this
             annotation. Each value should be between 0 and 1 (inclusive), and sum up to
             1 as a complete distribution. This can be useful for computing entropy to

nucleus/scene.py

@@ -381,7 +381,10 @@ class LidarScene(Scene):
         frames (Optional[List[:class:`Frame`]]): List of frames to be a part of
           the scene. A scene can be created before frames or items have been
           added to it, but must be non-empty when uploading to a :class:`Dataset`.
-        metadata (Optional[Dict]): Optional metadata to include with the scene.
+        metadata (Optional[Dict]):
+            Optional metadata to include with the scene.
+            Coordinate metadata may be provided to enable the Map Chart in the Nucleus Dataset charts page.
+            These values can be specified as `{"lat": 52.5, "lon": 13.3, ... }`.
 
     Refer to our `guide to uploading 3D data
     <https://docs.nucleus.scale.com/docs/uploading-3d-data>`_ for more info!

pyproject.toml

@@ -21,7 +21,7 @@ exclude = '''
 
 [tool.poetry]
 name = "scale-nucleus"
-version = "0.14.18"
+version = "0.14.19"
 description = "The official Python client library for Nucleus, the Data Platform for AI"
 license =  "MIT"
 authors = ["Scale AI Nucleus Team <nucleusapi@scaleapi.com>"]