Update docs

docs/whitelist.txt

@@ -1,4 +1,5 @@
 index.md
 layout/index.md
+layout/lenses.md
 dataset/index.md
 dtypes/index.md

renumics/spotlight/__init__.py

@@ -16,14 +16,15 @@
 from .viewer import Viewer, close, viewers, show
 from .plugin_loader import load_plugins
 from .settings import settings
+from .analysis.typing import DataIssue
 from . import cache, logging
 
 if not settings.verbose:
     logging.disable()
 
 __plugins__ = load_plugins()
 
-__all__ = ["show", "close", "viewers", "Viewer", "clear_caches"]
+__all__ = ["show", "close", "viewers", "Viewer", "clear_caches", "DataIssue"]
 
 
 def clear_caches() -> None:

renumics/spotlight/analysis/analyzers/cleanlab.py

@@ -36,9 +36,9 @@ def analyze_with_cleanlab(
 
         if len(rows):
             yield DataIssue(
-                severity="medium",
                 title="Outliers in embeddings",
                 rows=rows,
+                severity="medium",
                 columns=[column_name],
                 description=inspect.cleandoc(
                     """

renumics/spotlight/analysis/analyzers/cleanvision.py

@@ -4,7 +4,7 @@
 
 import os
 import inspect
-from typing import Iterable, List
+from typing import Dict, Iterable, List, Tuple
 from pathlib import Path
 from tempfile import TemporaryDirectory
 from contextlib import redirect_stderr, redirect_stdout
@@ -13,14 +13,12 @@
 import cleanvision
 
 from renumics.spotlight.dtypes import Image
-
 from renumics.spotlight.data_store import DataStore
-
 from ..decorator import data_analyzer
-from ..typing import DataIssue
+from ..typing import DataIssue, Severity
 
 
-_issue_types = {
+_issue_types: Dict[str, Tuple[str, Severity, str]] = {
     "is_light_issue": (
         "Bright images",
         "medium",
@@ -83,9 +81,9 @@
 def _make_issue(cleanvision_key: str, column: str, rows: List[int]) -> DataIssue:
     title, severity, description = _issue_types[cleanvision_key]
     return DataIssue(
-        severity=severity,
         title=title,
         rows=rows,
+        severity=severity,
         columns=[column],
         description=inspect.cleandoc(description),
     )

renumics/spotlight/analysis/typing.py

@@ -4,19 +4,23 @@
 
 from typing import Callable, Iterable, List, Literal, Optional
 
-from pydantic import BaseModel
+from pydantic.dataclasses import dataclass
 
 from renumics.spotlight.data_store import DataStore
 
 
-class DataIssue(BaseModel):
+Severity = Literal["low", "medium", "high"]
+
+
+@dataclass
+class DataIssue:
     """
     An Issue affecting multiple rows of the dataset
     """
 
-    severity: Literal["low", "medium", "high"] = "medium"
     title: str
     rows: List[int]
+    severity: Severity = "medium"
     columns: Optional[List[str]] = None
     description: str = ""
 

renumics/spotlight/dataset/__init__.py

@@ -95,7 +95,6 @@
     video_dtype,
 )
 
-
 from . import exceptions
 from .typing import (
     OutputType,
@@ -119,6 +118,10 @@
     ColumnInputType,
 )
 
+
+__all__ = ["Dataset"]
+
+
 INTERNAL_COLUMN_NAMES = ["__last_edited_by__", "__last_edited_at__"]
 INTERNAL_COLUMN_DTYPES = [str_dtype, datetime_dtype]
 

renumics/spotlight/dtypes/__init__.py

@@ -7,6 +7,26 @@
 from .legacy import Audio, Category, Embedding, Image, Mesh, Sequence1D, Video, Window
 
 
+__all__ = [
+    "CategoryDType",
+    "Sequence1DDType",
+    "bool_dtype",
+    "int_dtype",
+    "float_dtype",
+    "str_dtype",
+    "datetime_dtype",
+    "category_dtype",
+    "window_dtype",
+    "embedding_dtype",
+    "array_dtype",
+    "image_dtype",
+    "audio_dtype",
+    "mesh_dtype",
+    "sequence_1d_dtype",
+    "video_dtype",
+]
+
+
 class DType:
     _name: str
 
@@ -22,6 +42,10 @@ def name(self) -> str:
 
 
 class CategoryDType(DType):
+    """
+    Categorical dtype with predefined categories.
+    """
+
     _categories: Optional[Dict[str, int]]
     _inverted_categories: Optional[Dict[int, str]]
 
@@ -57,6 +81,10 @@ def inverted_categories(self) -> Optional[Dict[int, str]]:
 
 
 class Sequence1DDType(DType):
+    """
+    1D-sequence dtype with predefined axis labels.
+    """
+
     x_label: str
     y_label: str
 
@@ -78,36 +106,52 @@ def register_dtype(dtype: DType, aliases: list) -> None:
 
 
 bool_dtype = DType("bool")
+"""Bool dtype"""
 register_dtype(bool_dtype, [bool])
 int_dtype = DType("int")
+"""Integer dtype"""
 register_dtype(int_dtype, [int])
 float_dtype = DType("float")
+"""Float dtype"""
 register_dtype(float_dtype, [float])
 bytes_dtype = DType("bytes")
+"""Bytes dtype"""
 register_dtype(bytes_dtype, [bytes])
 str_dtype = DType("str")
+"""String dtype"""
 register_dtype(str_dtype, [str])
 datetime_dtype = DType("datetime")
+"""Datetime dtype"""
 register_dtype(datetime_dtype, [datetime])
 category_dtype = CategoryDType()
+"""Categorical dtype with arbitraty categories"""
 register_dtype(category_dtype, [Category])
 window_dtype = DType("Window")
+"""Window dtype"""
 register_dtype(window_dtype, [Window])
 embedding_dtype = DType("Embedding")
+"""Embedding dtype"""
 register_dtype(embedding_dtype, [Embedding])
 array_dtype = DType("array")
+"""numpy array dtype"""
 register_dtype(array_dtype, [np.ndarray])
 image_dtype = DType("Image")
+"""Image dtype"""
 register_dtype(image_dtype, [Image])
 audio_dtype = DType("Audio")
+"""Audio dtype"""
 register_dtype(audio_dtype, [Audio])
 mesh_dtype = DType("Mesh")
+"""Mesh dtype"""
 register_dtype(mesh_dtype, [Mesh])
 sequence_1d_dtype = Sequence1DDType()
+"""1D-sequence dtype with arbitraty axis labels"""
 register_dtype(sequence_1d_dtype, [Sequence1D])
 video_dtype = DType("Video")
+"""Video dtype"""
 register_dtype(video_dtype, [Video])
 mixed_dtype = DType("mixed")
+"""Unknown or mixed dtype"""
 
 
 DTypeMap = Dict[str, DType]

renumics/spotlight/layout/__init__.py

@@ -53,6 +53,22 @@
 )
 
 
+__all__ = [
+    "layout",
+    "split",
+    "tab",
+    "histogram",
+    "inspector",
+    "scatterplot",
+    "similaritymap",
+    "table",
+    "issues",
+    "wordcloud",
+    "confusion_matrix",
+    "metric",
+]
+
+
 _WidgetLike = Union[_Widget, str]
 _NodeLike = Union[Split, Tab, _WidgetLike, List]
 _LayoutLike = Union[str, os.PathLike, Layout, _NodeLike]

renumics/spotlight/layout/lenses.py

@@ -1,7 +1,7 @@
 """
 Viewers (lenses) for Spotlight inspector widget.
 
-For usage examples, see `renumics.spotlighth.layout.inspector`.
+For usage examples, see `renumics.spotlight.layout.inspector`.
 """
 
 import uuid