Skip to content

Commit 53e8361

Browse files
committed
documentation
1 parent be4c5ab commit 53e8361

8 files changed

+10
-14
lines changed

_doc/api/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ API
1111
batch
1212
mlmodel
1313
mlmodel_tree
14-
mlmodel_api
15-
tree
1614
search_rank
15+
sklapi
16+
tree
1717
blaslapack
1818
timeseries

_doc/api/mlmodel_tree.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ Criterions
4949
==========
5050

5151
The following classes require :epkg:`scikit-learn` *>= 1.3.0*,
52-
otherwise, they do not get compiled.
52+
otherwise, they do not get compiled. Section :ref:`blog-internal-api-impurity-improvement`
53+
explains why the execution may crash.
5354

5455
SimpleRegressorCriterion
5556
++++++++++++++++++++++++

mlinsights/mlmodel/_piecewise_tree_regression_common.pyx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ cdef class CommonRegressorCriterion(Criterion):
2323
It adds the features to the class.
2424
2525
If the file does not compile or crashes, some explanations are given
26-
in :ref:`scikit-learn internal API
27-
<blog-internal-api-impurity-improvement>`.
26+
in :ref:`blog-internal-api-impurity-improvement`.
2827
"""
2928
def __getstate__(self):
3029
return {}

mlinsights/mlmodel/piecewise_tree_regression.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ class PiecewiseTreeRegressor(DecisionTreeRegressor):
1414
* ``simple``: optimizes for a stepwise regression (equivalent to *mse*)
1515
1616
If the file does not compile or crashes, some explanations are given
17-
in :ref:`scikit-learn internal API
18-
<blog-internal-api-impurity-improvement>`.
17+
in :ref:`blog-internal-api-impurity-improvement`.
1918
"""
2019

2120
def __init__(

mlinsights/mlmodel/piecewise_tree_regression_criterion.pyx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ cdef class SimpleRegressorCriterion(CommonRegressorCriterion):
2828
It adds the features to the class.
2929
3030
If the file does not compile or crashes, some explanations are given
31-
in :ref:`scikit-learn internal API
32-
<blog-internal-api-impurity-improvement>`.
31+
in :ref:`blog-internal-api-impurity-improvement`.
3332
"""
3433
cdef float64_t* sample_w
3534
cdef float64_t* sample_wy

mlinsights/mlmodel/piecewise_tree_regression_criterion_fast.pyx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ cdef class SimpleRegressorCriterionFast(CommonRegressorCriterion):
2323
intermediate gains.
2424
2525
If the file does not compile or crashes, some explanations are given
26-
in :ref:`scikit-learn internal API
27-
<blog-internal-api-impurity-improvement>`.
26+
in :ref:`blog-internal-api-impurity-improvement`.
2827
"""
2928
cdef float64_t* sample_w_left
3029
cdef float64_t* sample_wy2_left

mlinsights/mlmodel/piecewise_tree_regression_criterion_linear.pyx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@ cdef class LinearRegressorCriterion(CommonRegressorCriterion):
2626
and is even slow as the criterion is more complex to compute.
2727
2828
If the file does not compile or crashes, some explanations are given
29-
in :ref:`scikit-learn internal API
30-
<blog-internal-api-impurity-improvement>`.
29+
in :ref:`blog-internal-api-impurity-improvement`.
3130
"""
3231
cdef SIZE_t n_features
3332
cdef const float64_t[:, ::1] sample_X

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ ignore_directives = [
9393
"runpython",
9494
]
9595
ignore_roles = ["epkg", "pr"]
96-
ignore_messages = "Duplicate implicit target name: \"setup.py\""
96+
ignore_messages = "Hyperlink target \"blog-internal-api-impurity-improvement\" is not referenced"
9797

9898
[tool.setuptools.packages.find]
9999
namespaces = false

0 commit comments

Comments
 (0)