lmcinnes/umap

Document reproducibility guarantees

Open

#298 建立於 2019年9月25日

在 GitHub 查看
 (16 留言) (0 反應) (0 負責人)Python (6,478 star) (751 fork)batch import
0.4documentationgood first issue

描述

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.)

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
PythonUMAP libraryrandom state conceptdocumentation writing
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
Review the discussion in PR #231 and issue #294 to understand the current behavior of random state and transform seed. The main task is to update the UMAP documentation to explain how to achieve reproducible results, including possibly changing the default random state to a seed. Files likely include the UMAP class docstring and the main documentation page. Also consider the trade offs with performance when setting random state to None.