[WIP] Doc change for context images (#357)

* Doc change for context images

* style

* style and scene

* Bump version and add comment

Author: Anthony Krivonos

CHANGELOG.md

@@ -5,12 +5,16 @@ 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.21](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.14.21) - 2022-09-28
+
+### Added
+- Support for `context_attachment` metadata values. See [upload metadata](https://nucleus.scale.com/docs/upload-metadata) for more information.
+
 ## [0.14.20](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.14.20) - 2022-09-23
 
 ### Fixed
 - Local uploads are correctly batched and prevents flooding the network with requests
 
-
 ## [0.14.19](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.14.19) - 2022-08-26
 
 ### Added

nucleus/__init__.py

@@ -416,7 +416,7 @@ def create_dataset(
 
                     {
                         "field_name": {
-                            "type": "category" | "number" | "text"
+                            "type": "category" | "number" | "text" | "json"
                             "choices": List[str] | None
                             "description": str | None
                         },

nucleus/annotation.py

@@ -134,7 +134,7 @@ class BoxAnnotation(Annotation):  # pylint: disable=R0902
             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, ... }`.
+            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,

nucleus/dataset_item.py

@@ -87,7 +87,11 @@ class DatasetItem:  # pylint: disable=R0902
           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, ... }`.
+          These values can be specified as `{ "lat": 52.5, "lon": 13.3, ... }`.
+
+          Context Attachments may be provided to display the attachments side by side with the dataset
+          item in the Detail View by specifying
+          `{ "context_attachments": [ { "attachment": 'https://example.com/1' }, { "attachment": 'https://example.com/2' }, ... ] }`.
 
           .. todo ::
               Shorten this once we have a guide migrated for metadata, or maybe link

nucleus/prediction.py

@@ -160,7 +160,7 @@ class BoxPrediction(BoxAnnotation):
             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, ... }`.
+            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

nucleus/scene.py

@@ -383,8 +383,13 @@ class LidarScene(Scene):
           added to it, but must be non-empty when uploading to a :class:`Dataset`.
         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, ... }`.
+            These values can be specified as `{ "lat": 52.5, "lon": 13.3, ... }`.
+
+            Context Attachments may be provided to display the attachments side by side with the dataset
+            item in the Detail View by specifying
+            `{ "context_attachments": [ { "attachment": 'https://example.com/1' }, { "attachment": 'https://example.com/2' }, ... ] }`.
 
     Refer to our `guide to uploading 3D data
     <https://docs.nucleus.scale.com/docs/uploading-3d-data>`_ for more info!
@@ -455,7 +460,15 @@ class VideoScene(ABC):
             List of items representing frames, to be a part of the scene. A scene can be created
             before items have been added to it, but must be non-empty when uploading to
             a :class:`Dataset`. A video scene can contain a maximum of 3000 items.
-        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, ... }`.
+
+            Context Attachments may be provided to display the attachments side by side with the dataset
+            item in the Detail View by specifying
+            `{ "context_attachments": [ { "attachment": 'https://example.com/1' }, { "attachment": 'https://example.com/2' }, ... ] }`.
         upload_to_scale (Optional[bool]): Set this to false in order to use
             `privacy mode <https://nucleus.scale.com/docs/privacy-mode>`_. If using privacy mode
             you must upload both a video_location and items to the VideoScene.

pyproject.toml

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