Docs /Templates/ sinapsis-data-visualization

TabularDataVisualization

sinapsis-data-visualizationVisualizationplotscorrelation_matrixmatplotlibpandas

Python template · sinapsis_data_visualization.templates.tabular_data_visualization

Overview

Template for visualizing tabular data with various plot types.

This template supports histograms, box plots, pie charts, correlation matrices, and categorical distributions for tabular data in pandas format.

Capabilities

Capabilities: not set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-data-visualization==1.0.0
uv pip install sinapsis-data-visualization==1.0.0
uv add sinapsis-data-visualization==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

text
str | None
Optional
Default: null
kwargs
dict[str, typing.Any]
Optional
Default: null
x_label
str | None
Optional
Default: null
y_label
str | None
Optional
Default: null
box_plot
bool
Optional
Default: false
fig_name
str
Optional
Default: "visualization"
metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
fig_title
str | None
Optional
Default: null
fig_width
int
Optional
Default: 10
histogram
bool
Optional
Default: false
pie_chart
bool
Optional
Default: false
fig_height
int
Optional
Default: 10
x_position
float
Optional
Default: 0.5
y_position
float
Optional
Default: 0.5
correlation

Whether to create a correlation matrix for numeric columns.

bool
Optional
Default: false
image_format
str
Optional
Default: "png"
target_column

Name of the target column.

str
Optional
Default: "target"
save_image_dir
str | None
Optional
Default: "/home/ariel/.cache/sinapsis"
categorical_dist

Whether to create distribution plots for categorical columns.

bool
Optional
Default: false
generic_field_key
str | None
Optional
Default: null
selected_features

List of features to plot (empty means all).

list[str]
Optional
Default: null
add_to_image_packets
bool
Optional
Default: true

Configuration example

Generated from documented defaults. Replace any placeholders and complete required nested settings before running.

yaml
templates:
  - template_name: "TabularDataVisualization"
    class_name: "TabularDataVisualization"
    attributes:
      text: null
      kwargs: null
      x_label: null
      y_label: null
      box_plot: false
      fig_name: "visualization"
      fig_title: null
      fig_width: 10
      histogram: false
      pie_chart: false
      fig_height: 10
      x_position: 0.5
      y_position: 0.5
      correlation: false
      image_format: "png"
      target_column: "target"
      save_image_dir: "/home/ariel/.cache/sinapsis"
      categorical_dist: false
      generic_field_key: null
      selected_features: null
      add_to_image_packets: true

Inheritance

Immediate parent: sinapsis_data_visualization.templates.base_visualization_template.BaseVisualizationTemplate

Environment variables

Environment definitions belong to their canonical Python modules.

No directly related environment variables listed.