From 4e45bcbc9a4ebdbdd3746359161135bebb341ddb Mon Sep 17 00:00:00 2001 From: Kai Xu <5985769+xukai92@users.noreply.github.com> Date: Mon, 13 Jun 2022 18:55:33 +0100 Subject: [PATCH] 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 --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1dce1c4..e201662 100644 --- 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 | Type1 | 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) | + +1 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