Update README to reflect all available estimators (#45)

* doc: update method summary table * doc: make the summary table nicer * doc: explain naming convention * doc: fix table formatting * doc: better footnote Co-authored-by: Kai Xu <[email protected]>
JuliaML · Jun 13, 2022 · 4e45bcb · 4e45bcb
1 parent e55e406
commit 4e45bcb
Showing 1 changed file with 7 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -43,11 +43,13 @@ r = densratio(x_nu, x_de, KLIEP(), optlib=OptimLib)
 The third argument of the `densratio` function is a density ratio estimator.
 Currently, this package implements the following estimators:
 
-| Estimator | References |
-| --------- | ---------- |
-| KMM       | [Huang et al. 2006](https://papers.nips.cc/paper/3075-correcting-sample-selection-bias-by-unlabeled-data.pdf) |
-| KLIEP     | [Sugiyama et al. 2008](https://link.springer.com/article/10.1007/s10463-008-0197-x) |
-| LSIF      | [Kanamori et al. 2009](http://www.jmlr.org/papers/volume10/kanamori09a/kanamori09a.pdf) |
+| Estimator | Type<sup>1</sup> | References |
+| --------- | ---- | ---------- |
+| Kernel Mean Matching | `KMM`, `uKMM` | [Huang et al. 2006](https://papers.nips.cc/paper/3075-correcting-sample-selection-bias-by-unlabeled-data.pdf) |
+| Kullback-Leibler Importance Estimation Procedure | `KLIEP` | [Sugiyama et al. 2008](https://link.springer.com/article/10.1007/s10463-008-0197-x) |
+| Least-Squares Importance Fitting | `LSIF` | [Kanamori et al. 2009](http://www.jmlr.org/papers/volume10/kanamori09a/kanamori09a.pdf) |
+
+<sup>1</sup> We use the naming convention of prefixing the type name with `u` for the unconstrained variant of the corresponding estimator.
 
 The fourth argument `optlib` specifies the optimization package used to implement
 the estimator. Some estimators are implemented with different optimization packages