Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
99 commits
Select commit Hold shift + click to select a range
503dc3c
wip
DeaMariaLeon Jun 16, 2025
03ccaf7
wip
DeaMariaLeon Jun 17, 2025
8376ce4
wip
DeaMariaLeon Jun 17, 2025
1dd81b9
fix one test
DeaMariaLeon Jun 17, 2025
f580197
fixed regex
DeaMariaLeon Jun 17, 2025
69edbe1
adding ? symbol to link
DeaMariaLeon Jun 18, 2025
da427f0
added hover
DeaMariaLeon Jun 18, 2025
b067542
better message
DeaMariaLeon Jun 18, 2025
32ff382
[doc build] Added docstring
DeaMariaLeon Jun 18, 2025
0ae3124
fixed steps link in pipeline
DeaMariaLeon Jun 18, 2025
5e8bd5a
[doc build] trigger doc build
DeaMariaLeon Jun 18, 2025
a4c98e6
[doc build] fixed link colors
DeaMariaLeon Jun 19, 2025
0804529
Merge remote-tracking branch 'upstream/main' into doclink
DeaMariaLeon Jun 19, 2025
c7ee9da
added test
DeaMariaLeon Jun 20, 2025
5cfc016
wip
DeaMariaLeon Jun 20, 2025
19549c3
fixed link when not found
DeaMariaLeon Jun 20, 2025
a8bb530
wip
DeaMariaLeon Jun 20, 2025
316cd14
[doc build] trigger doc build
DeaMariaLeon Jun 20, 2025
d5381ac
[doc build] try to fix space
DeaMariaLeon Jun 20, 2025
c7a0aa8
Partially addressing feedback
DeaMariaLeon Jul 22, 2025
074a388
Import at the top
DeaMariaLeon Jul 22, 2025
5265622
wider link
DeaMariaLeon Jul 22, 2025
25db46f
wip
DeaMariaLeon Jul 22, 2025
cc14b8e
fix test
DeaMariaLeon Jul 22, 2025
c9803fb
[doc build] Lood for the missing C link
DeaMariaLeon Jul 22, 2025
3580c8e
original size for ?, changed estimator_type to _class in base_py
DeaMariaLeon Jul 23, 2025
5087b1c
fix tests
DeaMariaLeon Jul 23, 2025
a7aa497
fix docstring
DeaMariaLeon Jul 23, 2025
1932397
Added for loop and removed confusing estimatory_type var name
DeaMariaLeon Jul 24, 2025
de32eb2
modified doc_link
DeaMariaLeon Jul 24, 2025
02ed3bb
fixing tests
DeaMariaLeon Jul 25, 2025
e72b9a3
docstring for doc_link
DeaMariaLeon Jul 25, 2025
e29b92a
Changing text_fragment
DeaMariaLeon Jul 25, 2025
84f65e3
[doc build] Build docs
DeaMariaLeon Jul 25, 2025
e3256dc
[doc build] Moved link to inside params column
DeaMariaLeon Jul 28, 2025
3ddb381
[doc build] added background to ?
DeaMariaLeon Jul 28, 2025
8d0d9e6
partial feedback
DeaMariaLeon Jul 28, 2025
6d07beb
Partial feedback
DeaMariaLeon Jul 28, 2025
8ec331f
[doc build] Added test, changelog, changed names
DeaMariaLeon Jul 29, 2025
d982fd3
[doc build] Correct changelog file
DeaMariaLeon Jul 29, 2025
0dc5a24
[doc build] Correct changelog file again
DeaMariaLeon Jul 29, 2025
8112423
[doc build] Remove unwanted file
DeaMariaLeon Jul 29, 2025
56a644c
Changed tests after feedback - wip
DeaMariaLeon Jul 29, 2025
889adb1
[doc build] Fix html, remove hardcoded css, no link by default
DeaMariaLeon Jul 29, 2025
e8798c8
[doc build] Remove commented lines
DeaMariaLeon Jul 29, 2025
3a8cfd8
[doc build] Fix css for link
DeaMariaLeon Jul 30, 2025
f9165c3
[doc build] css when link visited
DeaMariaLeon Jul 30, 2025
d2eb8b9
[doc build] Added docstring on hover to try suggestion
DeaMariaLeon Aug 4, 2025
a1e8f9d
[doc build] Added docstring on hover to try suggestion
DeaMariaLeon Aug 4, 2025
37bf77a
[doc build] adding numpydoc
DeaMariaLeon Aug 4, 2025
3a3a5bc
[doc build] vendoring numpydoc
DeaMariaLeon Aug 4, 2025
6498c85
[doc build] avoid multiple calls and css change
DeaMariaLeon Aug 4, 2025
532b2f6
[doc build] added param name and type - changed css
DeaMariaLeon Aug 4, 2025
4b152c0
[doc build] correct max-width
DeaMariaLeon Aug 4, 2025
cedc6f5
Remove nested ifs
DeaMariaLeon Aug 5, 2025
e681330
Remove repetitions
DeaMariaLeon Aug 5, 2025
832b52e
[doc build] Corrected missing space
DeaMariaLeon Aug 5, 2025
70153e4
[doc build]
DeaMariaLeon Aug 5, 2025
87cfa2e
Merge remote-tracking branch 'upstream/main' into doclink
DeaMariaLeon Aug 5, 2025
70302b4
[doc build] Try to build examples - again
DeaMariaLeon Aug 5, 2025
bf78126
[doc build] Try to build
DeaMariaLeon Aug 6, 2025
394c483
[doc build] added cache - set variables to None early
DeaMariaLeon Aug 7, 2025
e99cdfa
Simpler ifs
DeaMariaLeon Aug 7, 2025
3708623
[doc build] will this fail?
DeaMariaLeon Aug 7, 2025
1fa5d99
wip
DeaMariaLeon Aug 8, 2025
98b7d66
Revert "wip"
DeaMariaLeon Aug 8, 2025
7ca7880
wip
DeaMariaLeon Aug 8, 2025
08767a0
wip
DeaMariaLeon Aug 8, 2025
61e2331
wip
DeaMariaLeon Aug 8, 2025
208e2f0
Merge remote-tracking branch 'upstream/main' into doclink
DeaMariaLeon Aug 8, 2025
a2accf6
[doc build] again
DeaMariaLeon Aug 8, 2025
ac8c656
[doc build] Simpler if
DeaMariaLeon Aug 14, 2025
a2ab300
[doc build] Question mark + tooltip same column
DeaMariaLeon Aug 19, 2025
2e49eb9
Guillaumes changes
DeaMariaLeon Aug 20, 2025
96f6b44
Changed visibility to display to eliminate bottom 100% rule
DeaMariaLeon Aug 20, 2025
d3010d1
[doc build] forgot doc build
DeaMariaLeon Aug 20, 2025
c93ec76
[doc build] Add break line back - tooltip
DeaMariaLeon Aug 20, 2025
e047b23
[doc build] added scroll
DeaMariaLeon Aug 20, 2025
5b19d81
[doc build] fixed hover of copy icon
DeaMariaLeon Aug 21, 2025
7611f77
Merge branch 'main' into doclink
glemaitre Aug 21, 2025
31b245f
[doc build] add transition persistence
glemaitre Aug 21, 2025
a072a93
wip
DeaMariaLeon Aug 22, 2025
5c42e14
css work
DeaMariaLeon Aug 22, 2025
949b011
[doc build] css clean up
DeaMariaLeon Aug 22, 2025
c84354f
[doc build] max-height change
DeaMariaLeon Aug 22, 2025
6321248
dashed line
DeaMariaLeon Aug 23, 2025
993f732
[doc build] fix dashed line & test
DeaMariaLeon Aug 25, 2025
8f5c715
[doc build] removed extra space
DeaMariaLeon Aug 25, 2025
7e18ae9
[doc build] visited link style
DeaMariaLeon Aug 25, 2025
f62c5d0
[doc build] Added comments to css
DeaMariaLeon Aug 25, 2025
81c7fcc
[doc build] Hovering on cell
DeaMariaLeon Aug 25, 2025
654d2de
doc_link at the end
DeaMariaLeon Aug 26, 2025
dc86313
shorter line
DeaMariaLeon Aug 26, 2025
1ba6998
modified test, make keyword only, add default values, modified for loop
DeaMariaLeon Aug 26, 2025
1edf99b
added regex to test_params
DeaMariaLeon Aug 27, 2025
0e9f526
Remove __doc__ from tests in test_params
DeaMariaLeon Aug 27, 2025
050568c
Modified base
DeaMariaLeon Aug 27, 2025
5769213
Merge remote-tracking branch 'upstream/main' into doclink
DeaMariaLeon Aug 27, 2025
b55bfc6
[doc build] forgot doc build
DeaMariaLeon Aug 27, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- The parameter table in an HTML representation of :class:`base.BaseEstimator`
now has a link to the online documentation for each parameter.
By :user:`Dea María Léon <DeaMariaLeon>`
14 changes: 12 additions & 2 deletions sklearn/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ def get_params(self, deep=True):
out[key] = value
return out

def _get_params_html(self, deep=True):
def _get_params_html(self, deep=True, doc_link=""):
"""
Get parameters for this estimator with a specific HTML representation.

Expand All @@ -271,6 +271,11 @@ def _get_params_html(self, deep=True):
If True, will return the parameters for this estimator and
contained subobjects that are estimators.

doc_link : str
URL to the estimator documentation.
Used for linking to the estimator's parameters documentation
available in HTML displays.

Returns
-------
params : ParamsDict
Expand Down Expand Up @@ -319,7 +324,12 @@ def is_non_default(param_name, param_value):
[name for name, value in ordered_out.items() if is_non_default(name, value)]
)

return ParamsDict(ordered_out, non_default=non_default_ls)
return ParamsDict(
params=ordered_out,
non_default=non_default_ls,
estimator_class=self.__class__,
doc_link=doc_link,
)

def set_params(self, **params):
"""Set the parameters of this estimator.
Expand Down
Loading
Loading