To commit or not commit notebook output...
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- github-actions, jupyter-notebook
調査の方向性
まず、tutorials/rbfe_python_tutorial.html のドキュメントで使用されているノートブックと、ExampleNotebooks の .github/workflows/CI.yml にあるノートブック一覧および実行手順を比較します。OpenFF が埋め込みノートブック出力をどのように扱うかを確認し、その後、完了した出力がリポジトリとレンダリングされたドキュメントで一貫する workflow を定義して文書化します。
索引モデルが issue の本文から書いたものです。
説明
I do think that it is best practice to not keep the output BUT we need the output so that our docs render the output:
https://docs.openfree.energy/en/stable/tutorials/rbfe_python_tutorial.html
I think what we should do is maybe have CI do the rendering (it already does the running (at least on these notebooks https://github.com/OpenFreeEnergy/ExampleNotebooks/blob/main/.github/workflows/CI.yml#L68 we will want to make sure those are a 1-1 match of the notebooks we have in our docs))
We could have the result of running the notebooks committed on merge into main? That way it won't clutter up the PR (with each CI run you would need to pull changes) BUT I don't think that would actually help since the output would still be saved...
We could have RTD keep the output which would fix the issue of the docs not having the output BUT that means that if you clone the repo or view the repo with a web browser there still would be no output.
I am not really sure what we should do here, maybe see what OpenFF does? They have the same-ish setup for embedding notebooks in their docs.
This will probably be a bigger issue to work out BUT I think the typo fixes you have here are great 🎉 so could you include the output for now? I will turn this comment into an issue that we can use to discuss what we want to do RE: notebook output being committed.
Originally posted by @mikemhenry in https://github.com/OpenFreeEnergy/ExampleNotebooks/issues/163#issuecomment-2402982475
- 主要言語
- Jupyter Notebook
- スター
- 70
- フォーク
- 15
- 平均マージ
- 10時間 42分
- マージ済み PR（30日）
- 2
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
OpenFreeEnergy/ExampleNotebooks のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
OpenFreeEnergy/ExampleNotebooks#279 · コメント 1 件 ·
-
OpenFreeEnergy/ExampleNotebooks#277 · コメント 1 件 · 担当者 1 名 ·
-
OpenFreeEnergy/ExampleNotebooks#241 · リアクション 1 件 · 担当者 1 名 ·
OpenFreeEnergy/ExampleNotebooks の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
elastic/gradle-plugins#157 ·
-
Documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
cake-build/cake#5024 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
web-infra-dev/rspack#15847 ·
-
accepted bug wg/developer-experience-ecosystem
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
vllm-project/semantic-router#4062 · コメント 2 件 ·