skrub.DataOp.skb.description

DataOp.skb.description

A user-defined description or comment about the DataOp.

This can be set with DataOp.skb.set_description() and is displayed in the execution report generated with full_report() or report().

Examples

>>> import skrub
>>> a = skrub.var('a', 1)
>>> b = skrub.var('b', 2)
>>> c = (a + b).skb.set_description('the addition of a and b')
>>> c
<BinOp: add>
Result:
―――――――
3
>>> c.skb.description
'the addition of a and b'