Skip to content

Commit d758338

Browse files
Clarified how to show feature values
1 parent 41d2811 commit d758338

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/shapiq/plot/waterfall.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,9 @@ def waterfall_plot(
372372
373373
Args:
374374
interaction_values: The interaction values as an interaction object.
375-
feature_names: The names of the features. Defaults to ``None``.
375+
feature_names: The names of the features. Defaults to ``None``. To display feature values
376+
alongside feature names, provide strings in the format ``"value=feature"`` (e.g.,
377+
``"25=Age"``). The plot will show the value in gray and the feature name in black.
376378
show: Whether to show the plot. Defaults to ``False``.
377379
max_display: The maximum number of interactions to display. Defaults to ``10``.
378380
abbreviate: Whether to abbreviate the feature names. Defaults to ``True``.

0 commit comments

Comments
 (0)