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

Maintenance/tutorials and docs #138

Merged
merged 29 commits into from
Jun 6, 2024
Merged

Conversation

mcw92
Copy link
Member

@mcw92 mcw92 commented Jun 5, 2024

This PR updates the documentation to correspond with the current master branch. It adds a couple of new static pages, including:

  • Tutorial for using surrogate models in Propulate
  • Tutorial for using multi-rank workers using the example of the parallel sphere function
  • Tutorial for using multi-rank workers with PyTorch's DistributedDataParallel module
  • Explanation of PSO, CMA-ES and Nelder-Mead algorithms
  • Section explaining the different optimizer flavors available (in the simple Propulator tutorial about minimizing a mathematical function)

All index pages were updated accordingly. In addition, a bug in the torch_ddp_example.py script has been fixed (we actually forgot to wrap the model with DDP 🤦‍♀️ ...)

@mcw92 mcw92 added the documentation Improvements or additions to documentation label Jun 5, 2024
@mcw92 mcw92 requested a review from oskar-taubert June 5, 2024 17:04
@mcw92 mcw92 self-assigned this Jun 5, 2024
git checkout -b features/your-feature-name
```

5**Make Changes**: Make your desired changes to the codebase. Please stick to the following guidelines:
* `Propulate` uses [*Black*](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html) code style and so should you if you would like to contribute.
Copy link
Member

Choose a reason for hiding this comment

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

our pre-commit enforces this anyway, does it not?

@oskar-taubert oskar-taubert merged commit 99acbab into master Jun 6, 2024
1 check passed
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.

Update static ReadTheDocs pages to correspond with current master Docs for CMA-ES and PSO
3 participants