Docstring issues in random_projection_split functions · lmcinnes/umap#116 | Good First Issue

(2 comments) (0 reactions) (0 assignees)Python (751 forks)batch import

documentationhelp wanted

Repository metrics

Stars: (6,478 stars)
PR merge metrics: (平均マージ 2d 1h) (30d で 1 merged PR)

説明

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

コントリビューターガイド

調査方針: rp tree.py の4つの関数を調べ、ドキュメンテーション文字列の戻り値のセクションを更新して、戻り値の型を正確に記述してください。hyperplane offset は常に float です。hyperplane/hyperplane vector については、コードを確認して正しい型（例：numpy 配列）を判断してください。
技術スタック: python
領域: documentation
Issue 種別: ドキュメント
難度: 1
推定時間: 1時間未満
活動状況: アクティブ
明確さ: 明確
前提条件: なし
初心者向け度: 90