Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Reproducibility Review (main)

オープン
#5 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
55/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
jupyter-notebook, python, pytorch
領域
documentation

調査の方向性

ルート README とキャンペーン README から始め、次に fpdesign/campaign.py の build_argparser 周辺と、キャッシュ済み出力のチェックを調べます。記載されている in-silico-test notebook、GFP_DMS README、environment.yml、および古いパス参照を確認し、ドキュメントの修正と再現性の問題を切り分けます。完了条件は、記載されたコマンドと復元パスが fresh clone での動作を正確に説明し、報告された traceback や誤解を招く参照を避けていることです。

索引モデルが issue の本文から書いたものです。

説明

Repository: Arcadia-Science/FPguide
Branch: main
Commit: 29935e8cb7
Reviewed: 2026-09-03 21:27 UTC

Reproducibility review — Arcadia-Science/FPguide

Summary

This repository is unusually well documented for reproducibility: every folder carries its own README with ordered commands, the root README maps each entry point onto a four-tier "what can you actually regenerate" table, the conda environment is fully pinned with lock files plus OS/driver notes, and the tracked artifacts were deliberately chosen so the cheap entry points (msa_conservation/, experiment/, Section 1 of GFP_DMS/visualization.ipynb) run from a bare clone. Someone could clone this today and, after one ~325 MB release download, re-run the GFP_DMS analysis and the EGFP campaign analysis as documented. The remaining friction is at the heavy end: the in-silico-test/ deployed checkpoints are not published and their refit is not deterministic, and the committed design CSVs make the documented campaign "run" commands no-ops on a fresh clone.

Critical issues

None found.

Warnings
  • The in-silico-test/ deployed checkpoints are not published, and refitting them is not bit-reproducible. design_common.SURR_CKPT (trained_models/surrogate_final/cnn-max-d1_trainval.pt, design_common.py:147) and ORAC_CKPT (trained_models/oracle_sweep/cnn-max-d1_s0.pt, line 148) fall under the repo-wide *.pt ignore, as does trained_models/surrogate_cv3.csv, from which train_final_surrogate.py:40 derives its epoch budget. The rebuild path is documented (root README Tier 3, in-silico-test/README.md pipeline), but it is the full chain — ~2 GB of ESM-2/ProstT5 caches, sweep_peak_oracle.py --role both, cv_all_surrogate.py, train_final_surrogate.py — and train_final_surrogate.py:52 sets only torch.manual_seed(0) with no cuDNN determinism pinned, so a reproducer's surrogate will differ slightly from the one behind the numbers in in-silico-test/README.md ("Design results"). Either ship these two checkpoints alongside the reference clouds, or state in the README that exact numeric agreement is not expected.
  • The documented campaign run commands silently do nothing on a fresh clone. The design CSVs under design-campaign-EGFP/*/designs*/ are committed, and fpdesign/campaign.py:670–690 skips any pair/cell whose CSV already covers --trials. build_argparser (campaign.py:182–214) exposes no --force — only --rescore, --backfill-ppl, --probe — so bash run_sweep.sh / bash run_campaign.sh from the campaign README's "Run" section print "cached" and exit. Add a line telling reproducers to pass a different --outdir (or delete the CSVs) to actually re-execute. in-silico-test's equivalent _complete() skip is documented under "Notes and gotchas"; the campaign's is not.
Polish/nice to have
  • in-silico-test/sweep_results.ipynb cell 6 does a bare pd.read_csv("trained_models/surrogate_cv3.csv") and raises FileNotFoundError on a clone, whereas the root README's Tier 3 table says those entry points "fail with the command to run, not a traceback". load_sweep in the same notebook already degrades gracefully; the CV cell could too.
  • Paths with spaces and parentheses — experiment/plasmid constructs/ and (bright)his-morange_msa_07-in-pet-28a.fasta — force quoting and URL-escaping (experiment/README.md already has to write plasmid%20constructs).
  • ~175 MB of RCSB PDBx cache is committed under structures/experimental/ even though pockets.py self-populates it on a miss (structures/README.md says as much). 1G7K.pdbx and 1GFL.pdbx additionally exist at both structures/ and structures/experimental/, though that duplication is functional (pockets.STRUCT reads the top level, experimental_window the subdirectory).
  • The root README's Environment section documents only conda env create -f environment.yml; the exact-restore path (environment.linux-64.lock plus requirements.linux-64.txt plus pip install -e ./fpbase-extractor) is only in comments inside environment.yml. Worth surfacing.
  • Stale internal references: GFP_DMS/brightness_threshold.py:16 and GFP_DMS/embed_dms.py:16 name transform_dms.py, now transform_avgfp_dms.py; the stage bootstraps in in-silico-test/1_surrogate_oracle_training/*.py and 2_design_task_specification/*.py still prepend a removed msa/ directory to sys.path (harmless, but misleading).
  • GFP_DMS/README.md lane A ends in jupyter nbconvert --to notebook --execute --inplace visualization.ipynb, which rewrites a tracked 268 KB notebook and dirties git status on every reproduction run; --output to a scratch path would avoid that.
Suggestions
  • Publish the in-silico-test/ surrogate and oracle checkpoints (and surrogate_cv3.csv) in the same release as reference-cloud-v1. They are small, and this is the single change that moves the pub's core design experiment from "re-derive over many GPU-hours, non-deterministically" to "download and re-run".
  • Give the design engines an explicit --force, or have the wrapper scripts default to a timestamped --outdir, so "re-run the campaign" is one documented command rather than a manual delete of committed files.

Automated reproducibility review • model: claude-opus-5 • tokens: 569,237 in / 6,953 out • cache: 569,235 written, 0 read

主要言語
Jupyter Notebook
スター
0
フォーク
0
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。