API Reference
Functions
Build expressions that run UMAP or nearest neighbor search. They take column names, expressions or selectors.
- umap()
-
Embed rows into a low-dimensional space with UMAP.
- knn()
-
Find the approximate k nearest neighbors of every row with NNDescent.
- umap_from_knn()
-
Run UMAP on a precomputed k-nearest-neighbor graph.
Namespaces
Importing polars_umap registers a umap namespace on pl.Expr, pl.DataFrame and pl.LazyFrame.
- UmapExprNamespace
-
UMAP and nearest neighbor search on an expression.
- UmapDataFrameNamespace
-
UMAP on a DataFrame. Available as
df.umapafterimport polars_umap. - UmapLazyFrameNamespace
-
UMAP on a LazyFrame. Available as
lf.umapafterimport polars_umap.