API Reference / agent / tools / data /

profile.py

Dataset profiling.

Functions

Func

execute_data_profile

Line 9
execute_data_profile(**kwargs) -> Dict[str, Any]

Profile a dataset: shape, dtypes, missing values, stats, class distribution.

Backs the tuiml_profile_data tool.

Parameters

data
str
Dataset to profile: dataset_id, file path, or built-in name (arrives via **kwargs, like all parameters below).
target
str = None
Target column name, echoed back as target_column when the dataset has labels.

Returns

result
dict
On success: status ('success'), name, shape, n_samples, n_features, feature_names, dtypes (feature -> 'numeric'/'categorical'), missing_values, numeric_stats (per-feature mean/std/min/max/median) and, when labels exist, class_distribution. On failure: status ('error'), error and error_type.