lmcinnes/umap

Document reproducibility guarantees

Open

#298 opened on 2019年9月25日

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