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 (751 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (6,478 stars)
PR merge metrics
 (Avg merge 2d 1h) (1 merged PR in 30d)

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

Research direction
Inspect the four functions in rp tree.py and update the Returns section of their docstrings to accurately describe the return types. The hyperplane offset is always a float; for hyperplane/hyperplane vector, check the code to determine the correct type (e.g., numpy array).
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
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.
90