Skip to content

New directory for community contributions #2167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

saitcakmak
Copy link
Contributor

Summary: Establishes the directory structure for BoTorch community contributions, associated notebooks & unit tests. Updates CONTRIBUTING.md with instructions on where each type of contribution should be made.

Differential Revision: D52747159

@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Jan 12, 2024
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D52747159

@facebook-github-bot
Copy link
Contributor

@saitcakmak has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

saitcakmak added a commit to saitcakmak/botorch that referenced this pull request Jan 13, 2024
Summary:
Establishes the directory structure for BoTorch community contributions, associated notebooks & unit tests. Updates `CONTRIBUTING.md` with instructions on where each type of contribution should be made.


Differential Revision: D52747159

Pulled By: saitcakmak
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D52747159

Summary:
Establishes the directory structure for BoTorch community contributions, associated notebooks & unit tests. Updates `CONTRIBUTING.md` with instructions on where each type of contribution should be made.


Differential Revision: D52747159

Pulled By: saitcakmak
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D52747159

Copy link
Contributor

@Balandat Balandat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for putting this up. Curious why you chose this module structure over a top-level community folder (where the import path would be botorch.community.acquisition... rather than botorch_community.acquisition...). Would this cause any import headaches?

If we keep the current setup, should we rename community_notebooks to notebooks_community for consistency?

@saitcakmak
Copy link
Contributor Author

Curious why you chose this module structure over a top-level community folder (where the import path would be botorch.community.acquisition... rather than botorch_community.acquisition...).

I've considered both and went with the top-level folder for clearer separation between the two. I am also not a fan of many level deep directory structures, particularly when there's repetition (e.g., we would have botorch.models & botorch.community.models etc.). I think the top-level setup will make it easier to setup separate CIs for the two.

Would this cause any import headaches?

I didn't run into any issues in my testing. The example test & notebooks run fine after pip install -e ".[dev]".

If we keep the current setup, should we rename community_notebooks to notebooks_community for consistency?

We can, though I like the sound of community_notebooks better. FWIW, the notebooks directory doesn't include the notebooks we have on the website (those are in tutorials). It only has the tutorial performance tracking notebook, which is quite different than the notebooks we're targeting for the new directory.

@facebook-github-bot
Copy link
Contributor

@saitcakmak merged this pull request in ac19e24.

@saitcakmak saitcakmak deleted the export-D52747159 branch January 22, 2024 18:26
stefanpricopie pushed a commit to stefanpricopie/botorch that referenced this pull request Feb 27, 2024
Summary:
Establishes the directory structure for BoTorch community contributions, associated notebooks & unit tests. Updates `CONTRIBUTING.md` with instructions on where each type of contribution should be made.

Pull Request resolved: pytorch#2167

Reviewed By: SebastianAment

Differential Revision: D52747159

Pulled By: saitcakmak

fbshipit-source-id: e65d79d04c66a5a12f5d3c71aaaf001d36c4806b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Do not delete this pull request or issue due to inactivity. fb-exported Merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants