lmcinnes / lmcinnes/umap

Aligned umap docs mentions varying alignment params but they are not actually varied

Open
#548 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8.3k
Forks
871
Avg merge
1d 13h
Merged PRs (30d)
5

Description

Minor thing. In the aligned umap usage doc (https://umap-learn.readthedocs.io/en/latest/aligned_umap_basic_usage.html) it says:

> To make the visualization a little more interesting we’ll also vary some of the alignment parameters...

The example then goes on to adjust standard umap params (`n_neighbors` and `min_dist`) but not the alignment parameters.

I'm not sure of the best way to fix it: I wouldn't want to remove the helpful discussion of the umap_aligned parameters, but adding them into the example would change the example quite a bit.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open aligned_umap_basic_usage.html and inspect the example around the statement that alignment parameters are varied. Compare the parameters actually changed in the example with the surrounding discussion, then revise the wording or example so the documentation accurately describes what is varied; confirm the resulting explanation remains consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.