Skip to content

Commit 68f2572

Browse files
committed
documentation
1 parent 4b64d6e commit 68f2572

File tree

2 files changed

+13
-33
lines changed

2 files changed

+13
-33
lines changed

README.rst

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,9 @@
44

55
mlinsights: extensions to scikit-learn
66
======================================
7-
qqa
8-
.. image:: https://travis-ci.com/sdpython/mlinsights.svg?branch=main
9-
:target: https://app.travis-ci.com/github/sdpython/mlinsights/
10-
:alt: Build status
117

12-
.. image:: https://ci.appveyor.com/api/projects/status/uj6tq445k3na7hs9?svg=true
13-
:target: https://ci.appveyor.com/project/sdpython/mlinsights
14-
:alt: Build Status Windows
15-
16-
.. image:: https://circleci.com/gh/sdpython/mlinsights/tree/main.svg?style=svg
17-
:target: https://circleci.com/gh/sdpython/mlinsights/tree/main
18-
19-
.. image:: https://dev.azure.com/xavierdupre3/mlinsights/_apis/build/status/sdpython.mlinsights%20(2)
20-
:target: https://dev.azure.com/xavierdupre3/mlinsights/
8+
.. image:: https://dev.azure.com/xavierdupre3/mlinsights/_apis/build/status%2Fsdpython.mlinsights%20(2)?branchName=main
9+
:target: https://dev.azure.com/xavierdupre3/mlinsights/_build/latest?definitionId=16&branchName=main
2110

2211
.. image:: https://badge.fury.io/py/mlinsights.svg
2312
:target: http://badge.fury.io/py/mlinsights
@@ -51,21 +40,16 @@ mlinsights: extensions to scikit-learn
5140

5241
*mlinsights* extends *scikit-learn* with a couple of new models,
5342
transformers, metrics, plotting. It provides new trainers such as
54-
*QuantileLinearRegression* which trains a linear regression with *L1* norm
43+
**QuantileLinearRegression** which trains a linear regression with *L1* norm
5544
non-linear correlation based on decision trees, or
56-
*QuantileMLPRegressor* a modification of scikit-learn's MLPRegressor
45+
**QuantileMLPRegressor** a modification of scikit-learn's MLPRegressor
5746
which trains a multi-layer perceptron with *L1* norm.
58-
It also explores *PredictableTSNE* which trains a supervized
59-
model to replicate *t-SNE* results or a *PiecewiseRegression*
47+
It also explores **PredictableTSNE** which trains a supervized
48+
model to replicate *t-SNE* results or a **PiecewiseRegression**
6049
which partitions the data before fitting a model on each bucket.
50+
**PiecewiseTreeRegressor** trains a piecewise regressor using
51+
a linear regression on each piece. **IntervalRegressor** produces
52+
confidence interval by using bootstrapping. **ApproximateNMFPredictor**
53+
approximates a NMF to produce prediction without retraining.
6154

6255
`documentation <https://sdpython.github.io/doc/dev/mlinsights/>`_
63-
64-
Function ``pipeline2dot`` converts a pipeline into a graph:
65-
66-
::
67-
68-
from mlinsights.plotting import pipeline2dot
69-
dot = pipeline2dot(clf, df)
70-
71-
.. image:: https://raw.githubusercontent.com/sdpython/mlinsights/main/_doc/sphinxdoc/source/pipeline.png

_doc/index.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,11 @@
22
mlinsights: tricky scikit-learn
33
===============================
44

5-
.. image:: https://github.com/sdpython/mlinsights/blob/main/_doc/_static/project_ico.png?raw=true
5+
.. image:: https://raw.github.com/sdpython/mlinsights/blob/main/_doc/_static/project_ico.png
66
:target: https://github.com/sdpython/mlinsights/
77

8-
.. image:: https://travis-ci.com/sdpython/mlinsights.svg?branch=main
9-
:target: https://app.travis-ci.com/github/sdpython/mlinsights/
10-
:alt: Build status
11-
12-
.. image:: https://dev.azure.com/xavierdupre3/mlinsights/_apis/build/status/sdpython.mlinsights%20(2)
13-
:target: https://dev.azure.com/xavierdupre3/mlinsights/
8+
.. image:: https://dev.azure.com/xavierdupre3/mlinsights/_apis/build/status%2Fsdpython.mlinsights%20(2)?branchName=main
9+
:target: https://dev.azure.com/xavierdupre3/mlinsights/_build/latest?definitionId=16&branchName=main
1410

1511
.. image:: https://badge.fury.io/py/mlinsights.svg
1612
:target: http://badge.fury.io/py/mlinsights

0 commit comments

Comments
 (0)