Skip to content

Commit c8fb137

Browse files
DOC: Reword description about patching in preview mode (#2491)
* reword description about patching in preview * corrections about patching non-sklearn classes * include necessary file
1 parent 46e8ca3 commit c8fb137

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

doc/sources/non-scikit-algorithms.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@
1717
Non-Scikit-Learn Algorithms
1818
===========================
1919
Algorithms not presented in the original scikit-learn are described here. All algorithms are
20-
available for both CPU and GPU (including distributed mode)
20+
available for both CPU and GPU (including distributed mode).
21+
22+
.. Note::
23+
If using :ref:`patching <patching>`, these classes can be imported either from module ``sklearn``
24+
or from module ``sklearnex``.
2125

2226
.. autoclass:: sklearnex.basic_statistics.BasicStatistics
2327
:members:

doc/sources/preview.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
.. See the License for the specific language governing permissions and
1313
.. limitations under the License.
1414
15+
.. include:: substitutions.rst
1516
.. _preview:
1617

1718
#####################
@@ -29,8 +30,8 @@ for being enabled by default for all users:
2930
This type of functionality is available under **preview mode** of |sklearnex| and located in
3031
the corresponding module (`sklearnex.preview`).
3132

32-
Preview functionality *may* or *may not* participate in patching of Scikit-learn.
33-
For example, a preview estimator may be a replacement for a stock one or a completely new one.
33+
Functionalities under preview will be made available after patching when preview mode is enabled,
34+
but note that some might be :ref:`extension estimators <extension_estimators>` without analogs in |sklearn|.
3435

3536
To enable preview functionality, you need to set the `SKLEARNEX_PREVIEW` environment variable
3637
to non-empty value before patching of Scikit-learn.

0 commit comments

Comments
 (0)