API Reference / cli /

profile.py

Profile Command - Summarise a dataset before training.

Functions

Command

tuiml profile

Line 11
tuiml profile [OPTIONS]

Inspect a dataset before training.

Reports the shape, per-column dtypes, missing-value counts and basic summary statistics of a dataset, plus the class distribution when a target column is given. Accepts either a path to a data file or the name of a built-in dataset.

Profile a built-in dataset:

bash 
$ tuiml profile --data iris

Summarise a CSV together with its label column:

bash 
$ tuiml profile --data data.csv --target species

Emit the report as raw JSON for scripting:

bash 
$ tuiml profile --data data.csv --json-output

Options

--data
str required
Data file path or built-in dataset name (e.g., 'iris', 'wine', '/path/to/data.csv')
--target
str
Target column name (optional, used for class distribution)
--json-output
flag
Output raw JSON