mcpField
R
research-publishing

research-publishing

github.com/fcakyon開発43766 回インストール2 週間前に更新
リポジトリ

research-publishing について

research-publishingは、論文とともにコードや成果物を公開する研究者向けのスキルです。リポジトリのリスクと再現性を監査し、整理、ドキュメント作成、ライセンス選択、公開前テストを案内します。

主な機能

  1. 01機密情報のスキャン
  2. 02依存関係とライセンスの確認
  3. 03リポジトリ構成の点検
  4. 04再現性ドキュメントの作成支援
  5. 05ライセンス選択と公開テストの支援

活用シーン

  1. 01論文のコードを公開する準備
  2. 02実験の再現性の確認
  3. 03公開前の研究リポジトリ審査

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/fcakyon/phd-skills --skill research-publishing

インストール後、Claude Code で/research-publishingを入力して読み込まれたか確認します。

詳細

研究成果公開の方法

論文投稿とあわせて、研究者がコードや成果物を公開できるよう支援します。

ステップ 1：リポジトリの評価

変更を加える前に、現在の状態を監査します。

  1. 機密情報のスキャン：

    • API キー、トークン、認証情報（一般的なパターンを grep で検索）
    • 研究者のマシン固有のハードコードされたパス
    • 内部 URL や非公開のインフラへの参照
    • コメントやデータに含まれる個人を特定できる情報

  2. 依存関係の監査：

    • バージョンを固定したすべての依存関係を列挙する
    • プロプライエタリ、またはライセンスに制限のある依存関係を特定する
    • 放棄または保守されていない依存関係を確認する
    • すべての依存関係が pip/conda でインストール可能であることを確認する

  3. コードの整理状況：

    • 不要なコード、デバッグ用の成果物、一時ファイルを特定する
    • 統合すべき重複コードを見つける
    • 簡素化できる過度に複雑なコードを確認する

ステップ 2：リポジトリの構成

公開可能な研究リポジトリには、次のものを含める必要があります。

project/
  README.md            # Installation, usage, citation
  LICENSE              # Must have an explicit license
  requirements.txt     # or pyproject.toml with pinned deps
  setup.py / setup.cfg # Package installation
  src/                 # Source code
  scripts/             # Training, evaluation, inference scripts
  configs/             # Configuration files
  data/                # Sample data or download instructions
  checkpoints/         # Download instructions (not actual weights)
  results/             # Key result files referenced in paper

ステップ 3：再現性チェックリスト

論文の各実験について、次の項目を確認します。

  • 設定ファイルがあり、論文のハイパーパラメーターと一致している
  • 乱数シードが設定され、記録されている
  • 学習コマンドが最初から最後まで記載されている
  • 評価コマンドで報告された数値を再現できる
  • データの前処理手順がスクリプト化されている（手作業ではない）
  • ハードウェア要件（GPU の種類、メモリ、所要時間）が記載されている
  • 依存関係のバージョンが固定されている

ステップ 4：README の構成

研究成果の README には、次の項目を含める必要があります。

  1. タイトルと一行の説明
  2. 論文へのリンク（arXiv、掲載ページ）
  3. ビジュアル資料（アーキテクチャ図、主要な結果を示す図、またはデモ GIF）
  4. インストール方法（手順ごとに記載し、クリーンな環境でテスト済みであること）
  5. クイックスタート（単一の例で推論を実行する手順。コマンド数は 5 未満）
  6. 学習（完全な再現コマンド）
  7. 評価（論文の数値を再現する方法）
  8. モデル一覧／チェックポイント（期待される指標を添えたダウンロードリンク）
  9. 引用（BibTeX ブロック）
  10. ライセンス

ステップ 5：コードの整理

最小限かつ的を絞って整理します。

  1. デバッグ用の出力、コメントアウトされたコード、一時的な実験を削除する
  2. ハードコードされたパスを、設定可能なパス（環境変数または引数）に置き換える
  3. 公開関数に docstring を追加する（内部ヘルパーは除く）
  4. 主なエントリーポイントが明確に説明されていることを確認する
  5. スタイルを整えるためだけに動作中のコードをリファクタリングしないでください。メリットがない一方で、リスクが増します。

ステップ 6：ライセンスの選択

ライセンスの選択についてユーザーに案内します。

ライセンス商用利用を許可帰属表示が必要コピーレフト
MITはいはいいいえ
Apache 2.0はいはいいいえ（特許許諾あり）
GPL 3.0はいはいはい（二次的著作物）
CC BY 4.0はいはいいいえ（コード以外）
CC BY-NC 4.0いいえはいいいえ（コード以外）

推奨されるデフォルト：コードには MIT、データセット／モデルには CC BY 4.0。

ステップ 7：公開前のテスト

公開する前に、次の手順を実施します。

  1. 新しいディレクトリにクローンする
  2. README のインストール手順に正確に従う
  3. クイックスタートのコマンドを実行する
  4. 評価を実行し、数値が論文と一致することを確認する
  5. git の履歴に機密情報が含まれていないことを確認する

出力形式

次の内容を作成します。

  1. 監査レポート：見つかった機密情報、依存関係の問題、不要なコード
  2. 対応リスト：変更、削除、追加する具体的なファイル
  3. README の草案：上記の構成に従ったもの
  4. 再現性チェックリスト：実験ごとの検証状況

コメント

Markdown 対応