Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

To commit or not commit notebook output...

Đang mở
#164 4 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
github-actions, jupyter-notebook
Lĩnh vực
build-system, documentation

Hướng nghiên cứu

Bắt đầu bằng cách so sánh các notebook được tài liệu tại tutorials/rbfe_python_tutorial.html sử dụng với danh sách notebook và các bước thực thi trong .github/workflows/CI.yml của ExampleNotebooks. Xem xét cách OpenFF xử lý đầu ra notebook được nhúng, sau đó xác định và ghi lại một workflow mà đầu ra đã hoàn tất nhất quán trong repository và tài liệu được render.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
Jupyter Notebook
Star
70
Fork
15
Merge trung bình
10 giờ 42 phút
Pull request đã merge (30 ngày)
2

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của OpenFreeEnergy/ExampleNotebooks

Tất cả issue của OpenFreeEnergy/ExampleNotebooks

Issue tương tự

Thêm issue về Build System

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.