Skip to content

Commit 428ec66

Browse files
committed
cosmetic on README
1 parent ca43e3a commit 428ec66

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Qolmat can be installed in different ways:
4747
.. code:: sh
4848
4949
$ pip install qolmat # installation via `pip`
50-
$ pip install qolmat[pytorch] # if you need pytorch
50+
$ pip install qolmat[pytorch] # if you need ImputerDiffusion relying on pytorch
5151
$ pip install git+https://github.com/Quantmetry/qolmat # or directly from the github repository
5252
5353
⚡️ Quickstart
@@ -105,8 +105,8 @@ The full documentation can be found `on this link <https://qolmat.readthedocs.io
105105

106106
**How does Qolmat work ?**
107107

108-
Qolmat allows model selection for scikit-learn compatible imputation algorithms, by performing three steps pictured below:
109-
1) For each of the K folds, Qolmat artificially masks a set of observed values using a default or user specified `hole generator <explanation.html#hole-generator>`_,
108+
| Qolmat allows model selection for scikit-learn compatible imputation algorithms, by performing three steps pictured below:
109+
1) For each of the K folds, Qolmat artificially masks a set of observed values using a default or user specified `hole generator <explanation.html#hole-generator>`_.
110110
2) For each fold and each compared `imputation method <imputers.html>`_, Qolmat fills both the missing and the masked values, then computes each of the default or user specified `performance metrics <explanation.html#metrics>`_.
111111
3) For each compared imputer, Qolmat pools the computed metrics from the K folds into a single value.
112112

@@ -117,7 +117,7 @@ This is very similar in spirit to the `cross_val_score <https://scikit-learn.org
117117

118118
**Imputation methods**
119119

120-
The following table contains the available imputation methods. We distinguish single imputation methods (aiming for pointwise accuracy, mostly deterministic) from multiple imputation methods (aiming for distribution similarity, mostly stochastic).
120+
The following table contains the available imputation methods. We distinguish single imputation methods (aiming for pointwise accuracy, mostly deterministic) from multiple imputation methods (aiming for distribution similarity, mostly stochastic). For further details regarding the distinction between single and multiple imputation, you can refer to the `Imputation article <https://en.wikipedia.org/wiki/Imputation_(statistics)>`_ on Wikipedia.
121121

122122
.. list-table::
123123
:widths: 25 70 15 15

0 commit comments

Comments
 (0)