Skip to content

Documentation updates and new SlurmStopping callback #1692

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 59 commits into
base: main
Choose a base branch
from
Draft

Documentation updates and new SlurmStopping callback #1692

wants to merge 59 commits into from

Conversation

@alphataubio
Copy link

@alphataubio alphataubio commented Apr 15, 2025 •
edited
Loading

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Motivation and Context / Related issue

  • Documentation updates ( PREVIEW https://alphataubio.com/nevergrad/ )

    • sphinx docs refactored by sections (contents, api reference, examples, statistics)
    • automatic venv in docs/Makefile
    • Callbacks API split into its own ref page
    • minor editing to many pages
    • new "Strict constraints in continuous optimization" page

  • new SlurmStopping callback (EarlyStopping when 5 minutes left in SLURM job, no-op if not in SLURM job)

How Has This Been Tested (if it applies)

github action

Checklist

  • The documentation is up-to-date with the changes I made.
  • I have read the CONTRIBUTING document and completed the CLA (see CLA).
  • All tests passed, and additional code has been covered with new tests.

@alphataubio
add IncrementalHSICLogger callback
1821006
@alphataubio
add SlurmStopping callback
d978c8e
@alphataubio
split into CONTENTS / API REFERENCE / EXAMPLES
21d927f
@alphataubio
Update index.rst
4276d68
@alphataubio
replace deprecated recommonmark -> myst_parser
370c45e
@alphataubio
install venv automatically based on requirements.txt
1e99b31
@alphataubio
Create requirements.txt
807e809
@alphataubio
Update Makefile
49f3798
@alphataubio
Update requirements.txt
0cd16cb
@alphataubio
Update Diversity in image generation with Nevergrad.md
636ce10
@alphataubio
Update Guiding image generation with Nevergrad.md
b3e7bbb
@alphataubio
Update Lognormal mutations in Nevergrad.md
239aa17
@alphataubio
Update Retrofitting with Nevergrad.md
86d21f8
@alphataubio
Update base.py
8c1ed42
@alphataubio
Update conf.py
82527b9
@alphataubio
Update base.py
fb2f9e2
@alphataubio
winners2020.rst already included in opencompettition2020.md so can be…
33a851c 
… deleted
@alphataubio
Update conf.py
2e73f75
@alphataubio
Update index.rst
9a02d97
@alphataubio
Update oneshot.py
69686aa
@alphataubio
Update benchmarks.rst
36c7ea4
@alphataubio
Update index.rst
aabc535
@alphataubio
Update machinelearning.rst
d82ecfd
@alphataubio
Update pyomo.rst
8592f75
@alphataubio
Update r.rst
d890600
@alphataubio
Update AgStatistics.md
6480ffc
@alphataubio
Update Statistics.md
0d2563d
@alphataubio
Update index.rst
6451e93
@alphataubio
refactor api refs
d392b32
@alphataubio
Update callbacks.py
1f06c48
@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Apr 15, 2025
@alphataubio alphataubio changed the title Documentation updates, BisectionProjectionConstraint, Callbacks (SlurmStopping / IncrementalHSICLogger) Documentation updates, new BisectionProjectionConstraint, new callbacks (SlurmStopping / IncrementalHSICLogger) Apr 15, 2025
@alphataubio
get StartTime and TimeLimit from scontrol
cc0e9a0
@alphataubio
only do hsic update once per minute (default)
9e4b7c1
@alphataubio
Update machinelearning.rst
8bb473b
@alphataubio
flush hsic in background thread, avoid race condition
5e25e44
@alphataubio
infinite budget if None
f9c06f7
@alphataubio
Update optimization.rst
6cd3e2d
@alphataubio
add optional parameter_names for logging
291df63
@alphataubio
Update ref_parametrization.rst
4706371
@alphataubio
add "NEW" badge
351d36f
@alphataubio
infinite copyright
22aeeb2
@alphataubio
docs requirements.txt automatic Makefile venv now
f61d113
@alphataubio
first draft to improve contributing page
ef2ee3e
@alphataubio
Update contributing.rst
1a4c633
@alphataubio
add BisectionProjectionConstraint
99c0c9d
@alphataubio
Update ref_callbacks.rst
ce21c7c
@alphataubio
Update ref_optimizer.rst
9400bdb
@alphataubio
Update ref_parametrization.rst
1f418fb
@alphataubio
Update __init__.py
25a55aa
@alphataubio
first draft
0fecece
@alphataubio
Update parametrization.rst
5ff8d2b
@alphataubio
Update index.rst
1f2976a
@alphataubio
add NEW badge
09156be
@alphataubio
second draft
c7c5a04
@alphataubio
draft 3
fdb8d92
@alphataubio
Update parametrization.rst
1b503f0
@alphataubio alphataubio changed the title Documentation updates, new BisectionProjectionConstraint, new callbacks (SlurmStopping / IncrementalHSICLogger) Documentation updates and new SlurmStopping callback May 16, 2025
@alphataubio
Copy link
Author

@teytaud "This workflow is awaiting approval from a maintainer in #1692" for the tests to run on commit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

CLA Signed Do not delete this pull request or issue due to inactivity.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@alphataubio @facebook-github-bot