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

Update building docs #291

Merged
merged 21 commits into from
Jan 16, 2025
Merged

Update building docs #291

merged 21 commits into from
Jan 16, 2025

Conversation

jarlsondre
Copy link
Collaborator

@jarlsondre jarlsondre commented Jan 15, 2025

Summary

This PR contains three main changes:

  • Add GitHub Action for building the docs
  • Make the docs fail if it encounters any warnings (before it would build anyway)
  • Add scalability plots from Virgo and EURAC using 1, 2 and 4 nodes in the documentation

Additionally, this solves a bug in the Virgo use case where the config was always overridden to be empty.

Related Issues: #290

@jarlsondre jarlsondre self-assigned this Jan 15, 2025
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@jarlsondre jarlsondre marked this pull request as ready for review January 15, 2025 14:51
@jarlsondre jarlsondre changed the title [DRAFT] Update building docs Update building docs Jan 15, 2025
@jarlsondre jarlsondre added the documentation Improvements or additions to documentation label Jan 15, 2025
.github/workflows/build-docs.yml Outdated Show resolved Hide resolved
.github/workflows/build-docs.yml Outdated Show resolved Hide resolved
.github/workflows/pytest.yml Outdated Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
docs/getting-started/plugins.rst Outdated Show resolved Hide resolved
docs/how-it-works/training/explain_ddp.rst Outdated Show resolved Hide resolved
use-cases/virgo/config.yaml Outdated Show resolved Hide resolved
@jarlsondre jarlsondre requested a review from matbun January 16, 2025 12:58
@jarlsondre jarlsondre merged commit f7a0f74 into main Jan 16, 2025
14 checks passed
@jarlsondre jarlsondre deleted the update-docs-build branch January 16, 2025 13:41
annaelisalappe pushed a commit that referenced this pull request Jan 22, 2025
* add examples of scalability plots from virgo

* add scalability plots for virgo and eurac to docs

* small virgo bugfix

* fix warnings and add doc building action

* suppress myst.header warning

* fix undeline length

* remove some redundant files

* add back legacy scaling test report

* remove prov4ml from tests (hopefully)

* install prov4ml before testing

* add new virgo plots and fix epoch_time_tracker bug

* remove linux extra

* fix ci build files

* update docs readme with new changes and explanation for recurse submodules

* update acronyms and line lengths in explain ddp

* update batch_size in virgo and add explanation

* fix linter errors in readme

* fix linter errors in readme

* fix errors in PR
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants