Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit a897a34

Browse filesBrowse files
committed
DOC fix missing info and formatting for get_engine_classes
1 parent 2fa1489 commit a897a34
Copy full SHA for a897a34

File tree

1 file changed

+20
-6
lines changed
Filter options

1 file changed

+20
-6
lines changed

‎sklearn/_engine/base.py

Copy file name to clipboardExpand all lines: sklearn/_engine/base.py
+20-6Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,26 @@ def get_engine_classes(engine_name, default, verbose=False):
108108
match the name of enabled engine providers, as well as, ad-hoc providers
109109
in the form of engine classes in the list of enabled engine providers.
110110
111-
Returns
112-
-------
113-
For each matching provider the "name" and the engine class
114-
is yielded. The "name" corresponds to the entry in the
115-
`engine_provider` configuration. It can be a string or
116-
a class for ad-hoc providers.
111+
Parameters
112+
----------
113+
engine_name : str
114+
The name of the algorithm for which to find engine classes.
115+
116+
default : class
117+
The default engine class to use if no other provider is found.
118+
119+
verbose : bool, default=False
120+
If True, print the name of the engine classes that are tried.
121+
122+
Yields
123+
------
124+
provider : str or class
125+
The "name" of each matching provider. The "name" corresponds to the
126+
entry in the `engine_provider` configuration. It can be a string or a
127+
class for programmatically registered ad-hoc providers.
128+
129+
engine_class :
130+
The engine class that implements the algorithm for the given provider.
117131
"""
118132
provider_names = get_config()["engine_provider"]
119133

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.