lmcinnes/umap

Docstring issues in random_projection_split functions

Open

#116 ouverte le 10 août 2018

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Python (751 forks)batch import
documentationhelp wanted

Métriques du dépôt

Stars
 (6 478 stars)
Métriques de merge PR
 (Merge moyen 12h 3m) (15 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Inspectez les quatre fonctions dans rp tree.py et mettez à jour la section Returns de leurs docstrings pour décrire avec précision les types de retour. hyperplane offset est toujours un float; pour hyperplane/hyperplane vector, vérifiez le code pour déterminer le type correct (par exemple, tableau numpy).
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90