lmcinnes/umap

Docstring issues in random_projection_split functions

Open

#116 opened on Aug 10, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (6,478 stars) (751 forks)batch import
documentationhelp wanted

Description

Hi,

angular_random_projection_split, euclidean_random_projection_split, sparse_angular_random_projection_split and sparse_euclidean_random_projection_split all have the same docstring issue (the Returns section doesn't match what is returned by the function).

hyperplane_offset seems to always be a float. hyperplane (or hyperplane_vector) seems a bit harder to infer (it will likely be different for different functions).

angular_random_projection_split

https://github.com/lmcinnes/umap/blob/d286224a86dfe730c76f082c6f523b69b57bd0f8/umap/rp_tree.py#L45-L53

https://github.com/lmcinnes/umap/blob/d286224a86dfe730c76f082c6f523b69b57bd0f8/umap/rp_tree.py#L128

euclidean_random_projection_split

https://github.com/lmcinnes/umap/blob/d286224a86dfe730c76f082c6f523b69b57bd0f8/umap/rp_tree.py#L148-L156

https://github.com/lmcinnes/umap/blob/d286224a86dfe730c76f082c6f523b69b57bd0f8/umap/rp_tree.py#L217

sparse_angular_random_projection_split

https://github.com/lmcinnes/umap/blob/d286224a86dfe730c76f082c6f523b69b57bd0f8/umap/rp_tree.py#L242-L250

https://github.com/lmcinnes/umap/blob/d286224a86dfe730c76f082c6f523b69b57bd0f8/umap/rp_tree.py#L327

sparse_euclidean_random_projection_split

https://github.com/lmcinnes/umap/blob/d286224a86dfe730c76f082c6f523b69b57bd0f8/umap/rp_tree.py#L352-L360

https://github.com/lmcinnes/umap/blob/d286224a86dfe730c76f082c6f523b69b57bd0f8/umap/rp_tree.py#L436

Contributor guide

Tech stack
python
Domain
documentationmachine learning
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the four functions in umap/rp tree.py (lines 29-53, 132-156, 221-250, 331-360) and update the Returns section of their docstrings to accurately describe the return values. The hyperplane offset is always a float, and hyperplane/hyperplane vector type may vary per function. Consult the function implementations to determine the correct return types.