Initial doc updates for category (#156)

Author: cmpajot

nucleus/__init__.py

@@ -9,8 +9,8 @@
     "BoxAnnotation",
     "BoxPrediction",
     "CameraParams",
-    # "CategoryAnnotation", # coming soon!
-    # "CategoryPrediction", # coming soon!
+    "CategoryAnnotation",
+    "CategoryPrediction",
     "CuboidAnnotation",
     "CuboidPrediction",
     "Dataset",

nucleus/annotation.py

@@ -465,7 +465,19 @@ class AnnotationTypes(Enum):
 
 @dataclass
 class CategoryAnnotation(Annotation):
-    """This class is not yet supported: Categorization support coming soon!"""
+    """A category annotation.
+
+    Parameters:
+        label (str): The label for this annotation (e.g. car, pedestrian, bicycle).
+        taxonomy_name (str): The name of the taxonomy this annotation conforms to.
+        reference_id (str): The reference ID of the image you wish to apply this annotation to.
+        metadata (Optional[Dict]): Arbitrary key/value dictionary of info to 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.
+
+            .. todo::
+                Insert link to metadata guide
+    """
 
     label: str
     taxonomy_name: str
@@ -497,7 +509,7 @@ def to_payload(self) -> dict:
 
 @dataclass
 class MultiCategoryAnnotation(Annotation):
-    """This class is not yet supported: Categorization support coming soon!"""
+    """This class is not yet supported: MultiCategory annotation support coming soon!"""
 
     labels: List[str]
     taxonomy_name: str

nucleus/dataset.py

@@ -481,12 +481,25 @@ def add_taxonomy(
         taxonomy_type: str,
         labels: List[str],
     ):
-        """
-        Creates a new taxonomy.
-        Returns a response with dataset_id, taxonomy_name and type for the new taxonomy.
-        :param taxonomy_name: name of the taxonomy
-        :param type: type of the taxonomy
-        :param labels: list of possible labels for the taxonomy
+        """Creates a new taxonomy.
+        ::
+
+            import nucleus
+            client = nucleus.NucleusClient("YOUR_SCALE_API_KEY")
+            dataset = client.get_dataset("ds_bw6de8s84pe0vbn6p5zg")
+
+            dataset.add_taxonomy(taxonomy_name="clothing_type", type="category", labels=["shirt", "trousers", "dress"])
+
+        Args:
+            taxonomy_name:
+                The name of the taxonomy. Taxonomy names must be unique within a dataset.
+            taxonomy_type:
+                The type of this taxonomy as a string literal. Currently, the only supported taxonomy type is "category".
+            labels:
+                The list of possible labels for the taxonomy.
+
+        Returns:
+            Returns a response with dataset_id, taxonomy_name and type for the new taxonomy.
         """
         return self._client.make_request(
             construct_taxonomy_payload(taxonomy_name, taxonomy_type, labels),

nucleus/prediction.py

@@ -249,7 +249,24 @@ def from_json(cls, payload: dict):
 
 
 class CategoryPrediction(CategoryAnnotation):
-    """This class is not yet supported: Categorization support coming soon!"""
+    """A prediction of a category.
+
+    Parameters:
+        label: The label for this annotation (e.g. car, pedestrian, bicycle).
+        taxonomy_name: The name of the taxonomy this annotation conforms to.
+        reference_id: The reference ID of the image you wish to apply this annotation to.
+        confidence: 0-1 indicating the confidence of the prediction.
+        class_pdf: An optional complete class probability distribution on this
+            prediction. 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
+            surface places where the model is most uncertain.
+        metadata: Arbitrary key/value dictionary of info to 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.
+
+            .. todo::
+                Insert link to metadata guide
+    """
 
     def __init__(
         self,