Skip to content

Commit 02b4894

Browse files
saitcakmakfacebook-github-bot
authored andcommitted
Add community notebooks to the website (#2913)
Summary: We have a few notebooks under notebooks_community that were contributed by the BoTorch community. It's time to showcase these on the website! Pull Request resolved: #2913 Test Plan: https://github.com/user-attachments/assets/c8463b87-5979-4550-8714-e9248382436e With changes to make it only show when the content exists: https://github.com/user-attachments/assets/bf716e80-3154-4965-b35a-ebcaf7a96ceb Reviewed By: Balandat Differential Revision: D77872826 Pulled By: saitcakmak fbshipit-source-id: 0d4cfb62328d7438021623d750c9db03c3b99691
1 parent d6c3065 commit 02b4894

File tree

14 files changed

+353
-233
lines changed

14 files changed

+353
-233
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,10 @@ website/static/files/
102102
docs/tutorials/*
103103
!docs/tutorials/index.mdx
104104

105+
# Generated for community noteboooks
106+
docs/notebooks_community/*
107+
!docs/notebooks_community/index.mdx
108+
105109
## Generated for Sphinx
106110
website/pages/api/
107111
website/static/js/*

docs/notebooks_community/index.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Community Notebooks
3+
---
4+
This section of the website displays a list of notebooks contributed and maintained
5+
by the BoTorch community. These notebooks often showcase recent methods from the
6+
literature that are implemented using BoTorch.
7+
8+
Interested in contributing? Check out our [contributing guide](https://github.com/pytorch/botorch/blob/main/CONTRIBUTING.md#community-contributions-beta)!

notebooks_community/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,5 @@ Each notebook should include a timestamp of last update, as well as the version
88
of BoTorch that was used during execution. Each notebook should also list the
99
GitHub handle of its contributors, who may be asked for help in maintaining &
1010
updating the notebook against future versions for BoTorch and dependencies.
11+
12+
The notebooks are parsed and included in the BoTorch website.

0 commit comments

Comments
 (0)