再現可能な実験ノートテンプレート（SAENMベース）

本リポジトリは、JupyterLab と GitHub を用いた実験管理のためのテンプレートです。
Sequential Append-Only Experiment Notebook Model（SAENM） に基づき、再現性・透明性・共同作業性を高めることを目的としています。

参考情報: AI時代の研究運用を支えるSAENMという考え方

🎯 対象

• 研究プロジェクト（情報系・データ分析・AIなど）
• 大学教育（GitHubを活用した演習・課題）
• 企業研修（データ分析・AI実験のプロセス管理）

🧠 SAENMとは

SAENM（Sequential Append-Only Experiment Notebook Model）は、
実験プロセスを体系的に管理するための運用モデルです。

基本原則

1. Sequential（逐次的）

• 実験は番号順に記録する（01, 02, 03...）
• 各実験は前の結果を踏まえて進める

2. Append-only（追記型）

• 過去の実験は変更しない
• 修正や改善は新しい実験として追加する

3. Notebook中心

• 実験の実行は JupyterLab で行う

4. 考察の分離

• 実行結果と考察を分離する（Markdownで管理）

📂 ディレクトリ構成

project-root/
├─ notebooks/ # 実験（JupyterLab の Notebook (ipynb)）
├─ data/ # データ
├─ src/ # 再利用可能なコード
├─ docs/ # 運用ルール・説明
├─ results/ # 出力結果
├─ tests/ # テストコード

🔁 基本ワークフロー

1. 新しい実験ノートを作成: notebooks/01-initial-experiment.ipynb
2. 実験を実行
3. 考察をノートの最後に記録
4. 改善・追加実験: notebooks/02-improved-method.ipynb

📏 運用ルール

• 過去のNotebookは上書きしない
• 必ず新しい番号で実験を追加する
• 実行（Notebook）の最後に考察（Markdown）を記録する
• 再現可能な状態を保つ（環境・データを明示）

🤝 GitHub活用

GitHubを利用することで以下が可能になります。

• 実験の履歴管理
• Pull Requestによるレビュー
• 指導教員・チームメンバーとの共有

⚙️ 環境構築

uvを使用する場合：

uv sync

または：

pip install -r requirements.txt

🔍 CI（オプション）

GitHub Actionsにより、以下を自動化できます。

• Notebookの実行チェック
• フォーマットチェック
• 再現性の確認

📚 活用例

• 研究実験の記録と再現
• データ分析プロジェクト管理
• 大学の演習・課題提出
• AIを活用した実験プロセス管理

📄 ライセンス

MIT License

See: LICENSE

各実験は、自由にライセンスを決めてください。

🏷️ Maintained by

CMScomLab (https://github.com/CMScomLab/)