lmcinnes/umap

Document reproducibility guarantees

Open

#298 geöffnet am 25. Sept. 2019

Auf GitHub ansehen
 (16 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (751 Forks)batch import
0.4documentationgood first issue

Repository-Metriken

Stars
 (6.478 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 12h 3m) (15 gemergte PRs in 30 T)

Beschreibung

Following up on the discussion here, it would be good to document how to get reproducible results with UMAP.

I think we should consider changing random_state in the UMAP constructor to a seed (e.g. 42, like the new transform_seed default) so that UMAP is reproducible by default.

We should document that users can set random_state to None to get faster results at the expense of reproducibility. In this mode there is no seed that would produce the same output due to the multithreading. (This was introduced in #294.)

Contributor Guide

Research-Richtung
Überprüfen Sie die im Issue verlinkte Diskussion, um den Kontext zu verstehen. Lesen Sie dann die aktuelle UMAP Dokumentation und den Quellcode zu random state und Reproduzierbarkeit. Schlagen Sie Änderungen vor, um zu dokumentieren, wie reproduzierbare Ergebnisse erzielt werden, und erwägen Sie, den Standardwert von random state auf einen Seed zu setzen. Öffnen Sie bei Bedarf einen PR für die Dokumentation und mögliche Codeänderungen.
Tech Stack
python
Domain
data
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75