renumics.spotlight.layout

layout

This module allows user customize layout to start Spotlight from a python script/notebook.

A Spotlight layout consists of multiple widgets, grouped into tabs and splits.

layout

layout(
    *nodes: _NodeLike, orientation: Orientation = None
) -> Layout

Create a new layout with the given orientation and given nodes inside.

split

split(
    *nodes: _NodeLike,
    weight: Union[float, int] = 1,
    orientation: Orientation = None,
) -> Split

Create a new split with the given weight, orientation and given nodes inside.

tab

tab(
    *widgets: _WidgetLike, weight: Union[float, int] = 1
) -> Tab

Create a new tab with the given weight and given widgets inside.

parse

parse(layout_: _LayoutLike) -> Layout

Parse layout from a file, url, layout or given nodes.

histogram

histogram(
    name: Optional[str] = None,
    column: Optional[str] = None,
    stack_by_column: Optional[str] = None,
    filter_: bool = False,
) -> Histogram

Add configured histogram to Spotlight layout.

inspector

inspector(
    name: Optional[str] = None,
    lenses: Optional[Iterable[Lens]] = None,
    num_columns: NumInspectorColumns = 4,
) -> Inspector

Add an inspector widget with optionally preconfigured viewers (lenses).

Example

from renumics.spotlight import layout from renumics.spotlight.layout import lenses spotlight_layout = layout.layout( ... layout.inspector( ... "My Inspector", ... [ ... lenses.scalar("bool"), ... lenses.scalar("float"), ... lenses.scalar("str"), ... lenses.scalar("datetime"), ... lenses.scalar("category"), ... lenses.scalar("int"), ... lenses.text("str", name="text"), ... lenses.html("str", name="HTML (safe)"), ... lenses.html("str", name="HTML", unsafe=True), ... lenses.markdown("str", name="MD"), ... lenses.array("embedding"), ... lenses.array("window"), ... lenses.array("array"), ... lenses.sequences("sequence"), ... lenses.sequences(["sequence1", "sequence2"], name="sequences"), ... lenses.mesh("mesh"), ... lenses.image("image"), ... lenses.video("video"), ... lenses.audio("audio"), ... lenses.audio("audio", window_column="window", name="windowed audio"), ... lenses.spectrogram("audio"), ... lenses.spectrogram( ... "audio", ... window_column="window", ... name="windowed spectrogram", ... ), ... ], ... num_columns=2, ... ) ... )

scatterplot

scatterplot(
    name: Optional[str] = None,
    x_column: Optional[str] = None,
    y_column: Optional[str] = None,
    color_by_column: Optional[str] = None,
    size_by_column: Optional[str] = None,
    filter_: bool = False,
) -> Scatterplot

Add configured scatter plot to Spotlight layout.

similaritymap

similaritymap(
    name: Optional[str] = None,
    columns: Optional[List[str]] = None,
    reduction_method: Literal[None] = None,
    color_by_column: Optional[str] = None,
    size_by_column: Optional[str] = None,
    filter_: bool = False,
) -> Similaritymap

similaritymap(
    name: Optional[str] = None,
    columns: Optional[List[str]] = None,
    reduction_method: Literal["umap"] = "umap",
    color_by_column: Optional[str] = None,
    size_by_column: Optional[str] = None,
    filter_: bool = False,
    *,
    umap_metric: Optional[UmapMetric] = None,
    umap_balance: Optional[_UmapBalance] = None,
) -> Similaritymap

similaritymap(
    name: Optional[str] = None,
    columns: Optional[List[str]] = None,
    reduction_method: Literal["pca"] = "pca",
    color_by_column: Optional[str] = None,
    size_by_column: Optional[str] = None,
    filter_: bool = False,
    *,
    pca_normalization: Optional[PCANormalization] = None,
) -> Similaritymap

similaritymap(
    name: Optional[str] = None,
    columns: Optional[List[str]] = None,
    reduction_method: Optional[ReductionMethod] = None,
    color_by_column: Optional[str] = None,
    size_by_column: Optional[str] = None,
    filter_: bool = False,
    *,
    umap_metric: Optional[UmapMetric] = None,
    umap_balance: Optional[_UmapBalance] = None,
    pca_normalization: Optional[PCANormalization] = None,
) -> Similaritymap

Add configured similarity map to Spotlight layout.

table

table(
    name: Optional[str] = None,
    active_view: _TableTab = "all",
    visible_columns: Optional[List[str]] = None,
    sort_by_columns: Optional[
        List[Tuple[str, _SortOrder]]
    ] = None,
    order_by_relevance: bool = False,
) -> Table

Add configured table to Spotlight layout.

issues

issues(name: Optional[str] = None) -> Issues

Add a widget displaying data issues.

wordcloud

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.

confusion_matrix

confusion_matrix(
    name: Optional[str] = None,
    x_column: Optional[str] = None,
    y_column: Optional[str] = None,
) -> ConfusionMatrix

Add configured confusion matrix to Spotlight layout.

metric

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.