Skip to content
Uniform Manifold Approximation and Projection - R package
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R Update umap.R Nov 7, 2018
images
man update to vignette plot function Sep 13, 2018
src
tests
vignettes update to vignette plot function Sep 13, 2018
.Rbuildignore adjustments for CRAN submission Jun 25, 2018
.gitignore general update: vignette, Rcpp, tests, etc. May 5, 2018
.travis.yml
DESCRIPTION update to vignette plot function Sep 13, 2018
LICENSE adjustments for CRAN submission Jun 25, 2018
LICENSE.md
NAMESPACE
README.md

README.md

umap

R implementation of Uniform Manifold Approximation and Projection

Status codecov CRAN

Uniform manifold appximation and projection (UMAP) is a technique for dimensional reduction. The original algorithm was proposed by McInnes and Heyes and implemented in a python package umap. This package provides an interface to the UMAP algorithm in R, including a translation of the original algorithm into R with minimal dependencies.

Examples

The figure below shows dimensional reduction on the MNIST digits dataset. This dataset consists of 70,000 observations in a 784-dimensional space and labeled by ten distinct classes. The output of this package's `umap' function provides the plot layout, i.e. the arrangement of dots on the plane. The coloring, added to visualize how the known labels are positioned within the layout, demonstrates separation of the underlying data groups.

A UMAP visualization of the MNIST digits dataset

The package also allows to project data onto an existing embedding. Below, the first figure shows a map created from a subset of 60,000 observations from the MNIST data. The second figure is a projection of the held-out 10,000 observations onto the layout defined by the training data.

A UMAP visualization of the MNIST digits dataset A UMAP visualization of the MNIST digits dataset

More information on usage can be found in the package vignettes.

Implementations

The package provides two implementations of the UMAP algorithm.

The default implementation is one written in R and Rcpp. This implementation follows the original python code. However, any bugs or errors should be regarded as arising solely from this implementation, not from the original. The implementation has minimal dependencies and should work on most platforms. (The MNIST graphic is generated based on this default implementation).

A second implementation is a wrapper for the python package. This offers similar functionality to another existing package umapr. To use this implementation, additional installation steps are required; see documentation for the python package for details.

Note: an independent R implementation of UMAP is also available in a separate package uwot.

References

The original UMAP algorithm is described in the following article

McInnes, Leland, and John Healy. "UMAP: Uniform Manifold Approximation and Projection for Dimension Reduction." arXiv:1802.03426.

License

MIT License.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.