Sketchmap

docs/src/conf.py

@@ -60,6 +60,7 @@
     "regression",
     "reconstruction",
     "neighbors",
+    "decomposition",
 ]
 sphinx_gallery_conf = {
     "filename_pattern": "/*",

docs/src/getting-started.rst

@@ -52,3 +52,17 @@ Notebook Examples
    :start-line: 4
 .. include:: examples/pcovc/index.rst
    :start-line: 4
+
+.. _getting_started-decomposition:
+
+Non-linear Dimensionality Reduction
+-----------------------------------
+
+.. automodule:: skmatter.decomposition
+   :noindex:
+
+Notebook Examples
+^^^^^^^^^^^^^^^^^
+
+.. include:: examples/decomposition/index.rst
+   :start-line: 4

docs/src/index.rst

@@ -82,6 +82,23 @@
                 </div>
                 </div>
             </div>
+            <div class="col-sm d-flex">
+                <div class="card text-center mb-4" style="background-color: transparent">
+                <div class="card-body">
+                    <h5 class="card-title" style="margin-top: 0px">
+
+.. only:: html
+
+  :ref:`getting_started-decomposition`
+
+.. raw:: html
+
+                    </h5>
+                    <p class="card-text">Non-linear dimensionality reduction using
+                    Sketch-map algorithm with transfer functions.</p>
+                </div>
+                </div>
+            </div>
         </div>
     </div>
     <br>

docs/src/references/decomposition.rst

@@ -70,3 +70,18 @@ Kernel PCovC
     .. automethod:: inverse_transform
     .. automethod:: decision_function
     .. automethod:: score
+
+.. _SketchMap-api:
+
+SketchMap
+---------
+
+.. autoclass:: skmatter.decomposition.SketchMap
+    :show-inheritance:
+    :special-members:
+
+    .. automethod:: fit
+    .. automethod:: transform
+    .. automethod:: fit_transform
+    .. automethod:: predict
+    .. automethod:: score

examples/decomposition/README.rst

@@ -0,0 +1,2 @@
+Decomposition
+=============

examples/decomposition/sketchmap.py

@@ -0,0 +1,59 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+"""
+Sketch-map example using pre-selected high-dimensional landmarks
+==================================================================
+
+This example demonstrates a minimal, sphinx-gallery friendly usage of the `SketchMap`
+estimator. It loads the provided landmark file, fits the estimator on the landmark set
+(using per-sample `sample_weights`) and plots the resulting 2D embedding.
+
+note::
+
+  The example fits only the landmark set (callers that want a subset
+  should pre-select and pass that array to `fit`).
+"""
+
+# %%
+import numpy as np
+from matplotlib import pyplot as plt
+from matplotlib import cm
+
+from skmatter.decomposition import SketchMap
+
+
+# %%
+#
+# Load example landmark data. The file included with the examples contains
+# high-dimensional descriptors and the last column holds a per-sample weight.
+
+data_file = "highd-landmarks"
+data = np.loadtxt(data_file)
+X_land = data[:, :-1]
+weights = data[:, -1]
+
+
+# %%
+#
+# Fit SketchMap on the landmark set and provide `sample_weights`. We fit on the
+# landmarks only here (no FPS or internal selection).
+
+sm = SketchMap(n_components=2, auto_histogram=True, preopt_steps=50)
+sm.fit(X_land, sample_weights=weights, mixing_ratio=0.2, n_components=2)
+T = sm.embedding_
+
+# %%
+#
+# Plot the resulting embedding colored by the per-sample weight.
+
+cmap = cm.get_cmap("viridis")
+fig, ax = plt.subplots(figsize=(6, 5))
+sc = ax.scatter(T[:, 0], T[:, 1], c=weights, s=40, cmap=cmap, edgecolor="k")
+ax.set_title("Sketch-map embedding (example)")
+ax.set_xlabel("Sketchmap 1")
+ax.set_ylabel("Sketchmap 2")
+cbar = fig.colorbar(sc, ax=ax)
+cbar.set_label("landmark weight")
+fig.tight_layout()
+plt.show()

src/skmatter/decomposition/__init__.py

@@ -44,11 +44,14 @@
 from ._kernel_pcovr import KernelPCovR
 from ._kernel_pcovc import KernelPCovC
 
+from ._sketchmap import SketchMap
+
 __all__ = [
     "_BasePCov",
     "_BaseKPCov",
     "PCovR",
     "PCovC",
     "KernelPCovR",
     "KernelPCovC",
+    "SketchMap",
 ]