hyrax.verbs.umap#

Attributes#

Classes#

Umap

Umap latent space points into 2d

Module Contents#

logger[source]#
class Umap(config)[source]#

Bases: hyrax.verbs.verb_registry.Verb

Umap latent space points into 2d

__init__()[source]#

Overall initialization for all verbs that saves the config

cli_name = 'umap'[source]#
add_parser_kwargs[source]#
description = 'Transforms the entire dataset into a lower-dimensional space by fitting a UMAP model.'[source]#
static setup_parser(parser: argparse.ArgumentParser)[source]#

Stub of parser setup

run_cli(args: argparse.Namespace | None = None)[source]#

Stub CLI implementation

run(input_dir: pathlib.Path | str | None = None, model_path: pathlib.Path | str | None = None)[source]#

Deprecated wrapper for reduce_dimensions running the UMAP algorithm.

This wrapper delegates execution to reduce_dimensions with algorithm='umap' so that umap verb remains available for backward compatibility. But users are encouraged to switch to using reduce_dimensions.

Parameters:
  • input_dir (str or Path, Optional) – The directory containing the inference results.

  • model_path (str or Path, Optional) – The path to a pre-existing UMAP model.

Returns:

The method does not return anything but saves the UMAP representations to disk.

Return type:

None

_run(input_dir: pathlib.Path | str | None = None, model_path: pathlib.Path | str | None = None)[source]#

See run()