lmcinnes/umap

Docstring issues in random_projection_split functions

Open

#116 创建于 2018年8月10日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)Python (6,478 star) (751 fork)batch import
documentationhelp wanted

描述

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

贡献者指南

技术栈
python
领域
documentationmachine learning
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
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.