Merge pull request #227 from Renumics/feature/165-factories-for-newes…

…t-layout-widgets

Feature/165 factories for newest layout widgets

.gitignore

@@ -19,6 +19,7 @@ test_install/
 __pycache__/
 .mypy_cache/
 .pytest_cache/
+.ruff_cache/
 .ipynb_checkpoints/
 
 # Spotlight licenses

Makefile

@@ -21,8 +21,8 @@ init-playbook: ## Locally install all playbook dev dependencies
 
 .PHONY: clean
 clean: ## clean project
-	rm -fr build/ .pytest_cache/ .mypy_cache/
-	-rm -rf node_modules
+	rm -rf build/ .pytest_cache/ .ruff_cache/ .mypy_cache/
+	rm -rf node_modules
 
 .PHONY: audit
 audit: ## Audit project dependencies

pyproject.toml

@@ -106,7 +106,6 @@ packaging = "^21.3"
 nbmake = "^1.3.0"
 selenium = "^4.1.3, <4.10"
 diffimg = "^0.3.0"
-lesscpy = "^0.15.0"
 safety = "^1.10.3"
 typer = "^0.4.1"
 pre-commit = "^2.19.0"

renumics/spotlight/layout/__init__.py

@@ -26,11 +26,15 @@
 )
 from .lenses import Lens
 from .widgets import (
+    ConfusionMatrix,
+    ConfusionMatrixConfig,
     Histogram,
     HistogramConfig,
     Inspector,
     InspectorConfig,
     Issues,
+    MetricWidget,
+    MetricWidgetConfig,
     NumInspectorColumns as _NumInspectorColumns,
     PCANormalization as _PCANormalization,
     ReductionMethod as _ReductionMethod,
@@ -43,6 +47,9 @@
     TableView as _TableView,
     UmapMetric as _UmapMetric,
     Widget as _Widget,
+    WordCloud,
+    WordCloudConfig,
+    WordCloudScaling as _WordCloudScaling,
 )
 
 
@@ -361,3 +368,70 @@ def issues(name: Optional[str] = None) -> Issues:
     """
 
     return Issues(name=name)
+
+
+def wordcloud(
+    name: Optional[str] = None,
+    column: Optional[str] = None,
+    min_word_length: Optional[int] = None,
+    stop_words: Optional[Iterable[str]] = None,
+    scaling: Optional[_WordCloudScaling] = None,
+    max_word_count: Optional[int] = None,
+    filter: Optional[bool] = None,
+) -> WordCloud:
+    """
+    Add configured confusion matrix to Spotlight layout.
+    """
+    if min_word_length is not None and min_word_length < 1:
+        raise ValueError(
+            f"`min_word_length` argument should be positive, but value "
+            f"{min_word_length} received."
+        )
+    if max_word_count is not None and max_word_count < 1:
+        raise ValueError(
+            f"`max_word_count` argument should be positive, but value "
+            f"{max_word_count} received."
+        )
+    return WordCloud(
+        name=name,
+        config=WordCloudConfig(
+            column=column,
+            min_word_length=min_word_length,
+            stop_words=None if stop_words is None else list(stop_words),
+            scaling=scaling,
+            max_word_count=max_word_count,
+            filter=filter,
+        ),
+    )
+
+
+def confusion_matrix(
+    name: Optional[str] = None,
+    x_column: Optional[str] = None,
+    y_column: Optional[str] = None,
+) -> ConfusionMatrix:
+    """
+    Add configured confusion matrix to Spotlight layout.
+    """
+    return ConfusionMatrix(
+        name=name,
+        config=ConfusionMatrixConfig(x_column=x_column, y_column=y_column),
+    )
+
+
+def metric(
+    name: Optional[str] = None,
+    metric: Optional[str] = None,
+    columns: Optional[Union[str, Iterable[Optional[str]]]] = None,
+) -> MetricWidget:
+    """
+    Add configured metric widget to Spotlight layout.
+    """
+    metric_columns: List[Optional[str]] = []
+    if isinstance(columns, str):
+        metric_columns.append(columns)
+    elif columns is not None:
+        metric_columns.extend(columns)
+    return MetricWidget(
+        name=name, config=MetricWidgetConfig(metric=metric, columns=metric_columns)
+    )

renumics/spotlight/layout/widgets.py

@@ -156,13 +156,38 @@ class Issues(Widget):
     type: Literal["IssuesWidget"] = "IssuesWidget"
 
 
+WordCloudScaling = Literal["log", "linear", "sqrt"]
+
+
+class WordCloudConfig(WidgetConfig):
+    """
+    Config for the Word Cloud Widget.
+    """
+
+    column: Optional[str] = Field(None, alias="cloudByColumnKey")
+    min_word_length: Optional[int] = Field(None, alias="minWordLength")
+    stop_words: Optional[List[str]] = Field(None, alias="stopwords")
+    scaling: Optional[WordCloudScaling] = Field(None, alias="scaling")
+    max_word_count: Optional[int] = Field(None, alias="wordCount")
+    filter: Optional[bool] = Field(None, alias="hideFiltered")
+
+
+class WordCloud(Widget):
+    """
+    Word Cloud Widget.
+    """
+
+    type: Literal["wordcloud"] = "wordcloud"
+    config: Optional[WordCloudConfig] = None
+
+
 class ConfusionMatrixConfig(WidgetConfig):
     """
     Config for the Confusion Matrix Widget.
     """
 
-    x_column: Optional[str] = Field(default_factory=None, alias="xColumn")
-    y_column: Optional[str] = Field(default_factory=None, alias="yColumn")
+    x_column: Optional[str] = Field(None, alias="xColumn")
+    y_column: Optional[str] = Field(None, alias="yColumn")
 
 
 class ConfusionMatrix(Widget):

src/widgets/MetricsWidget/metrics.ts

@@ -36,7 +36,7 @@ export const METRICS: Record<string, Metric> = {
     accuracy: {
         signature: {
             X: ['bool', 'int', 'Category'],
-            y: ['bool', 'int', 'Category'],
+            Y: ['bool', 'int', 'Category'],
         },
         compute: ([actualValues, assignedValues]) => {
             const all = actualValues.length;