Skip to content
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

[BE] lint/test/docs on PR and push to main #742

Merged
merged 51 commits into from
Jul 13, 2024
Merged

Conversation

lbluque
Copy link
Collaborator

@lbluque lbluque commented Jun 26, 2024

  • Added a push event trigger to run tests on the main branch.
  • Added event PR event trigger for lint workflow (this double runs linting, but allows running it on PRs from outside forks).
  • Docs building (without deployment) is triggered once a PR review is submitted - this prevents merging PR that break docs.
  • Docs building + deployment is triggered when a new release is published.
  • Docs are now all fixed (thanks @zulissimeta!).

@lbluque lbluque requested a review from misko June 26, 2024 17:44
Copy link

codecov bot commented Jun 26, 2024

Codecov Report

Attention: Patch coverage is 55.17241% with 13 lines in your changes missing coverage. Please review.

Files Coverage Δ
src/fairchem/core/trainers/ocp_trainer.py 66.31% <ø> (ø)
src/fairchem/core/common/relaxation/ase_utils.py 62.76% <0.00%> (ø)
...m/core/common/relaxation/optimizers/lbfgs_torch.py 15.75% <0.00%> (ø)
src/fairchem/core/trainers/base_trainer.py 85.46% <61.53%> (-1.00%) ⬇️

... and 3 files with indirect coverage changes

@zulissimeta
Copy link
Collaborator

The docs will build on main with this, but the build always succeed even if some of the notebooks fail. I'm looking to see whether there's an easy flag to make the build fail if any notebooks fail so that it's obvious when there's a doc problem.

@lbluque lbluque changed the title lint/test on PR and push to main lint/test/docs on PR and push to main Jun 27, 2024
@lbluque lbluque changed the title lint/test/docs on PR and push to main [BE] lint/test/docs on PR and push to main Jul 9, 2024
@zulissimeta zulissimeta requested a review from misko July 9, 2024 22:22
rayg1234
rayg1234 previously approved these changes Jul 12, 2024
@mshuaibii mshuaibii mentioned this pull request Jul 13, 2024
Copy link
Collaborator

@zulissimeta zulissimeta left a comment

Choose a reason for hiding this comment

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

Final tests passed!

@zulissimeta zulissimeta added this pull request to the merge queue Jul 13, 2024
Merged via the queue into main with commit aacb883 Jul 13, 2024
8 checks passed
@zulissimeta zulissimeta deleted the lint-test-triggers branch July 13, 2024 03:19
@lbluque lbluque mentioned this pull request Jul 18, 2024
@zulissimeta zulissimeta added documentation Improvements or additions to documentation patch Patch version release labels Aug 13, 2024
misko pushed a commit that referenced this pull request Jan 17, 2025
* lint/test on PR and push to main

* Run docs CI on every push to main

* Fail docs when a notebook doesn't build

* skip eval_metrics fix in tutorial_utils

* when writing extxyz in docs, specific force as a column explicitly

* task.dataset -> dataset.format

* small fixes in config in tutorial

* make train dataset optional if only used test dataset

* more small fixes if you don't specify a train dataset

* loss_fns -> loss_functions in tutorial

* eval_metrics -> evaluation_metrics in OCP tutorial

* FixAtoms as int

* don't clear train dataset if present but src is missing

* invert train dataset load logic

* fix logic

* bool mask

* require docs test on main

* pull_request_review to trigger doc build

* use FixAtoms fix from stress-relaxations branch

* sneak in a push trigger to test docs

* upload only html artifact

* sneaky push

* fix artifact path

* fix job names

* no deploy docs on push

* add devcontainer settings

* small fix to legacy tutorial

* small fix to legacy tutorial

* another small tutorial fix

* add rest of tutorial back

* clean up logic in load_datasets

* typo

* logic typo in load_datasets

* convert all md to ipynb on launch

* add minimum spec on devcontainer to make sure everything runs

* include subdirectories in conversion

* 758 fix

* minor fixes

* relax otf

* typo

* try removing comments in build_docs yml

---------

Co-authored-by: zulissimeta <122578103+zulissimeta@users.noreply.github.com>
Co-authored-by: Zack Ulissi <zulissi@meta.com>
Co-authored-by: Muhammed Shuaibi <mushuaibi@gmail.com>
Former-commit-id: c76e5452e86c740ceffb26fe308853328788dfad
beomseok-kang pushed a commit to beomseok-kang/fairchem that referenced this pull request Jan 27, 2025
* lint/test on PR and push to main

* Run docs CI on every push to main

* Fail docs when a notebook doesn't build

* skip eval_metrics fix in tutorial_utils

* when writing extxyz in docs, specific force as a column explicitly

* task.dataset -> dataset.format

* small fixes in config in tutorial

* make train dataset optional if only used test dataset

* more small fixes if you don't specify a train dataset

* loss_fns -> loss_functions in tutorial

* eval_metrics -> evaluation_metrics in OCP tutorial

* FixAtoms as int

* don't clear train dataset if present but src is missing

* invert train dataset load logic

* fix logic

* bool mask

* require docs test on main

* pull_request_review to trigger doc build

* use FixAtoms fix from stress-relaxations branch

* sneak in a push trigger to test docs

* upload only html artifact

* sneaky push

* fix artifact path

* fix job names

* no deploy docs on push

* add devcontainer settings

* small fix to legacy tutorial

* small fix to legacy tutorial

* another small tutorial fix

* add rest of tutorial back

* clean up logic in load_datasets

* typo

* logic typo in load_datasets

* convert all md to ipynb on launch

* add minimum spec on devcontainer to make sure everything runs

* include subdirectories in conversion

* 758 fix

* minor fixes

* relax otf

* typo

* try removing comments in build_docs yml

---------

Co-authored-by: zulissimeta <122578103+zulissimeta@users.noreply.github.com>
Co-authored-by: Zack Ulissi <zulissi@meta.com>
Co-authored-by: Muhammed Shuaibi <mushuaibi@gmail.com>
Former-commit-id: da152c95058bdeca87deff82f4e1e33c1f8cddca
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation patch Patch version release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants