lmcinnes/umap

Docstring issues in random_projection_split functions

Open

#116 opened on 2018年8月10日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)Python (6,478 stars) (751 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.