API Reference / cli /

describe.py

Describe Command - Show the parameter schema for any TuiML component.

Functions

Command

tuiml describe

Line 10
tuiml describe [OPTIONS]

Show details and the parameter schema for a TuiML component.

Looks a component up in the component registry by its exact class name and reports what it does along with the parameters it accepts, their types and their defaults. Works for algorithms, preprocessing steps, feature selectors and built-in datasets alike.

Inspect an algorithm and its hyperparameters:

bash
$ tuiml describe --name RandomForestClassifier

Inspect a preprocessing step:

bash
$ tuiml describe --name SimpleImputer

Inspect a built-in dataset:

bash
$ tuiml describe --name iris

Options

--name
str required
Component name (e.g., 'RandomForestClassifier', 'SimpleImputer', 'iris')
--json-output
flag
Output raw JSON