ENH Adding a column to link each parameter docstring row in params table display #31564

DeaMariaLeon · 2025-06-17T08:44:59Z

Reference Issues/PRs

Adds a column with a link to each parameter docstring in the params table (in the HTML display).
This was discussed while working on the PR that added the table.

"Text fragments" code shared by @ogrisel here :
#30763 (comment)

What does this implement/fix? Explain your changes.

Added a column to the table with the new link
Modified ParamsDict to include the estimator_type. After several tries it was the only way I found at the moment.

Any other comments?

@glemaitre

github-actions · 2025-06-17T08:45:58Z

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

_{Generated for commit: 8184ab5. Link to the linter CI: here}

DeaMariaLeon · 2025-06-18T10:42:10Z

~~Example here~~

TODO:

Address Olivier's comment (during a call). He mentioned that the ReprHTMLMixin could be set-up in a way that we only add documentation link of estimators that have similar HTML structure.
Test for broken links
The "?" link is too small, but it's the same size of the text. ~~latest doc built~~ - It seems that having the same text for each hyperlink is different than the recommended "best practices".

sklearn/utils/_repr_html/params.py

jeremiedbb

Thanks for the PR @DeaMariaLeon.

I tested on the example you linked and it worked fine except for the C parameter of LogisticRegression. Maybe the text fragment requires more than 1 character ?

Besides that, here are some comments

sklearn/base.py

sklearn/utils/_repr_html/params.py

DeaMariaLeon · 2025-07-22T08:42:15Z

tested on the example you linked and it worked fine except for the C parameter of LogisticRegression. Maybe the text fragment requires more than 1 character ?

Thanks for the feedback! - the link to C that you mention works for me locally. But the link to my example doesn't work (the whole example, not the parameter link). Maybe on the next doc build I can see it.. ?
I addressed some of the comments you left. I'll work on the rest.

ogrisel · 2025-08-25T15:14:48Z

I'm not sure that linking to the full doc page is necessary then but why not if you want to have the rst properly rendered.

+1 for keeping the link. Sometimes the rendering can be helpful (e.g. math). Furthermore, when browsing from a mobile device without a mouse, there is no way to get the tooltip so better keep a "click to navigate to doc" interaction in addition to the tooltip.

DeaMariaLeon · 2025-08-26T07:11:47Z

The docs have been built. Gaël's feedback was added.
Example here

GaelVaroquaux · 2025-08-26T07:20:49Z

I haven't reviewed the code, but from a user perspective, I think that it looks absolutely great, and it's definitely mergeable for me!! Thanks!

glemaitre

OK here is a pass on the code more in details. I propose some slight changes.

sklearn/base.py

sklearn/utils/_repr_html/estimator.js

sklearn/utils/_repr_html/params.py

sklearn/utils/_repr_html/tests/test_params.py

DeaMariaLeon · 2025-08-27T09:22:36Z

@glemaitre I think I addressed all your comments.

glemaitre

LGTM on my side. It looks like a net improvement.
@jeremiedbb do you want to have a final look for merging the PR.

jeremiedbb

Here's a new pass. It's great but I think that we can improve the usability a little bit, see my comments below.

sklearn/externals/_numpydoc/docscrape.py

doc/whats_new/upcoming_changes/sklearn.utils/31564.enhancement.rst

jeremiedbb · 2025-08-30T16:07:24Z

sklearn/utils/_repr_html/params.css

+    `table td`is set in notebook with right text-align.
+    We need to overwrite it.
+*/
+.estimator-table table td.param {


The tooltip appears on hovering over the a.param-doc-link element but there's a big padding on td.param, see

I wonder if we could get rid of the td.param padding such that the a element takes all the space (probably need to set a margin to keep having some space around the text)

There is no padding for that - or at least I don't see it. And if one looks at the whole column, it's as wide as the widest parameter name. So loss has an empty space, but could you show the whole column please? Or maybe you could share the code so I can see it locally? thanks

There is still the padding in td.param. It's a lot less problematic now that the tooltip has moved a bit to the right. I wonder however if it's possible to remove the padding on td.param and add a margin on a.param-doc-link instead. Because right now we can hover over some parts off the cell without triggering the apparition of the tooltip which is a bit weird. Not a major issue though.

@jeremiedbb I'm so sorry: I don't see the td.param padding that you mention. Which line do you mean? Did you see my previous comment? params is as wide as it's wider param name. There is no padding for that.
Could you share the screenshot of your whole column please? I must be missing something.

oh, I think the padding is added by the browser. So I must force it to 0.

sklearn/utils/_repr_html/params.css

jeremiedbb · 2025-08-30T16:15:18Z

sklearn/utils/_repr_html/tests/test_params.py

+def test_generate_link_to_param_doc_special_characters():
+    class MockEstimator:
+        """Mock class
+        param with space : {'stay', 'leave'} default='don't know'


does such a param exists ? I don't see how a parameter could have a space in it's name in Python.

Removed it.
I had added this test when I was struggling with the link generation. Sometimes it had spaces in-between.. but not in the param name. I was looking for a whole line with spaces in between as you had suggested.
Anyway, I deleted it. Thanks.

sklearn/utils/_repr_html/tests/test_params.py

DeaMariaLeon · 2025-09-01T06:53:52Z

@jeremiedbb it's failing because of "ModuleNotFoundError: No module named 'numpydoc'" - this is after the suggestion here.

I'm not sure what the best way to go is. Should I add the file I removed back? Should this be a dependency?
(I think that now it's only an optional dependency).
I'd be happy to hear your thoughts.

jeremiedbb · 2025-09-01T08:54:19Z

(I think that now it's only an optional dependency).

Oh right my bad I forgot about that.

Should I add the file I removed back?

yes please, sorry for the misleading request

DeaMariaLeon · 2025-09-01T11:44:16Z

Don't worry. Be happy. 🙂

DeaMariaLeon · 2025-09-01T15:26:15Z

Friendly ping @jeremiedbb.. because it's green.

FYI I did the last (previous) commit because the parameter's value column was right-aligned (in the ci).

jeremiedbb

I just have one last comment, everything looks good otherwise.

jeremiedbb · 2025-09-01T15:48:06Z

sklearn/utils/_repr_html/params.css

+    `table td`is set in notebook with right text-align.
+    We need to overwrite it.
+*/
+.estimator-table table td.param {


There is still the padding in td.param. It's a lot less problematic now that the tooltip has moved a bit to the right. I wonder however if it's possible to remove the padding on td.param and add a margin on a.param-doc-link instead. Because right now we can hover over some parts off the cell without triggering the apparition of the tooltip which is a bit weird. Not a major issue though.

jeremiedbb · 2025-09-01T15:49:22Z

doc/whats_new/upcoming_changes/sklearn.utils/31564.enhancement.rst

+  more generally of estimators inheriting from :class:`base.BaseEstimator`
+  now displays the parameter description as a tooltip and has a link to the online
+  documentation for each parameter.
+  By :user:`Dea María Léon <DeaMariaLeon>`


Suggested change

By :user:`Dea María Léon <DeaMariaLeon>`

By :user:`Dea María Léon <DeaMariaLeon>`.

Olivier asked me to remove it here #31564 (comment)

sklearn/utils/_repr_html/params.css

DeaMariaLeon · 2025-08-21T13:40:50Z

sklearn/utils/_repr_html/params.css

+    /* Hide by default */
+    opacity: 0;
+    visibility: hidden;
+    pointer-events: none;


@glemaitre When visibility is hidden the element stays in the DOM, and it adds extra empty space between the cell where you are, and the next one. That's why I had display:none.
Here are the docs

The empty space (bottom of the cell):

sklearn/utils/_repr_html/params.css

sklearn/utils/_repr_html/params.py

sklearn/utils/_repr_html/params.css

DeaMariaLeon · 2025-09-01T06:31:52Z

sklearn/utils/_repr_html/tests/test_params.py

+def test_generate_link_to_param_doc_special_characters():
+    class MockEstimator:
+        """Mock class
+        param with space : {'stay', 'leave'} default='don't know'


Removed it.
I had added this test when I was struggling with the link generation. Sometimes it had spaces in-between.. but not in the param name. I was looking for a whole line with spaces in between as you had suggested.
Anyway, I deleted it. Thanks.

sklearn/utils/_repr_html/tests/test_params.py

DeaMariaLeon · 2025-09-01T16:37:16Z

sklearn/utils/_repr_html/params.css

+    `table td`is set in notebook with right text-align.
+    We need to overwrite it.
+*/
+.estimator-table table td.param {


@jeremiedbb I'm so sorry: I don't see the td.param padding that you mention. Which line do you mean? Did you see my previous comment? params is as wide as it's wider param name. There is no padding for that.
Could you share the screenshot of your whole column please? I must be missing something.

DeaMariaLeon · 2025-09-01T17:07:25Z

I'm not sure if you will see my comment. You asked me to add the . here, but Olivier had asked me to remove it earlier.
By :user:Dea María Léon <DeaMariaLeon>.`

I think I understood what you mean with the padding, but I'm not 100% sure.

DeaMariaLeon added 3 commits June 16, 2025 20:08

wip

503dc3c

wip

03ccaf7

wip

8376ce4

github-actions bot added the module:utils label Jun 17, 2025

DeaMariaLeon added 2 commits June 17, 2025 11:25

fix one test

1dd81b9

fixed regex

f580197

glemaitre self-requested a review June 17, 2025 21:20

DeaMariaLeon added 4 commits June 18, 2025 10:23

adding ? symbol to link

69edbe1

added hover

da427f0

better message

b067542

[doc build] Added docstring

32ff382

DeaMariaLeon added 10 commits June 18, 2025 13:47

fixed steps link in pipeline

0ae3124

[doc build] trigger doc build

5e8bd5a

[doc build] fixed link colors

a4c98e6

Merge remote-tracking branch 'upstream/main' into doclink

0804529

added test

c7ee9da

wip

5cfc016

fixed link when not found

19549c3

wip

a8bb530

[doc build] trigger doc build

316cd14

[doc build] try to fix space

d5381ac

DeaMariaLeon marked this pull request as ready for review June 20, 2025 12:25

DeaMariaLeon changed the title ~~WIP: ENH Adding a column to link each parameter docstring row in params table display~~ ENH Adding a column to link each parameter docstring row in params table display Jun 20, 2025

DeaMariaLeon commented Jul 7, 2025

View reviewed changes

sklearn/utils/_repr_html/params.py Show resolved Hide resolved

jeremiedbb reviewed Jul 21, 2025

View reviewed changes

Partially addressing feedback

c7a0aa8

Import at the top

074a388

[doc build] Hovering on cell

81c7fcc

glemaitre reviewed Aug 26, 2025

View reviewed changes

DeaMariaLeon added 8 commits August 26, 2025 15:20

doc_link at the end

654d2de

shorter line

dc86313

modified test, make keyword only, add default values, modified for loop

1ba6998

added regex to test_params

1edf99b

Remove __doc__ from tests in test_params

0e9f526

Modified base

050568c

Merge remote-tracking branch 'upstream/main' into doclink

5769213

[doc build] forgot doc build

b55bfc6

glemaitre approved these changes Aug 29, 2025

View reviewed changes

jeremiedbb reviewed Aug 30, 2025

View reviewed changes

DeaMariaLeon added 3 commits September 1, 2025 08:02

Added margin to tooltip, rm file numpydoc-docsrape, corrected changelog

3a36f4f

Added docstrings to test_params, removed useless test

8225666

Merge remote-tracking branch 'upstream/main' into doclink

ebe2723

DeaMariaLeon added 2 commits September 1, 2025 13:41

Add back docsrape

cb642ee

[doc build] Build docs with examples

1cf2b59

[doc build] added back text-align important - jupyter was overwriting

124aeda

jeremiedbb reviewed Sep 1, 2025

View reviewed changes

DeaMariaLeon commented Sep 1, 2025

View reviewed changes

[doc build] force padding to 0 to td_param

8184ab5

	By :user:`Dea María Léon <DeaMariaLeon>`
	By :user:`Dea María Léon <DeaMariaLeon>`.

Uh oh!

ENH Adding a column to link each parameter docstring row in params table display #31564

Are you sure you want to change the base?

ENH Adding a column to link each parameter docstring row in params table display #31564

Conversation

DeaMariaLeon commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Any other comments?

Uh oh!

github-actions bot commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✔️ Linting Passed

Uh oh!

DeaMariaLeon commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

jeremiedbb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DeaMariaLeon commented Jul 22, 2025

Uh oh!

ogrisel commented Aug 25, 2025

Uh oh!

DeaMariaLeon commented Aug 26, 2025

Uh oh!

GaelVaroquaux commented Aug 26, 2025

Uh oh!

glemaitre left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DeaMariaLeon commented Aug 27, 2025

Uh oh!

glemaitre left a comment

Choose a reason for hiding this comment

Uh oh!

jeremiedbb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DeaMariaLeon Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

DeaMariaLeon commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DeaMariaLeon commented Jun 17, 2025 •

edited

Loading

github-actions bot commented Jun 17, 2025 •

edited

Loading

DeaMariaLeon commented Jun 18, 2025 •

edited

Loading

DeaMariaLeon Sep 1, 2025 •

edited

Loading

DeaMariaLeon commented Sep 1, 2025 •

edited

Loading

DeaMariaLeon Sep 1, 2025 •

edited

Loading