skrub.Expr.skb.set_description

Expr.skb.set_description(description)

Give a description to this expression.

Returns a modified copy.

The description can help document our pipeline. It is displayed in the execution report and can be retrieved from the .skb.description attribute.

Parameters:

descriptionstr

The description

Returns:

A new expression with the provided description.

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'