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

DOC update for the run_once sampling strategy #700

Merged
merged 11 commits into from
Jun 5, 2024

Conversation

MatDag
Copy link
Contributor

@MatDag MatDag commented Apr 17, 2024

Update the documentation for the case where sampling_strategy is set to run_once

Copy link
Member

@tomMoral tomMoral left a comment

Choose a reason for hiding this comment

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

some comments

benchopt/base.py Outdated Show resolved Hide resolved
doc/tutorials/add_solver.rst Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jun 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.27%. Comparing base (a017a82) to head (4a0c107).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #700   +/-   ##
=======================================
  Coverage   81.27%   81.27%           
=======================================
  Files          45       45           
  Lines        3108     3108           
=======================================
  Hits         2526     2526           
  Misses        582      582           

@@ -148,7 +148,7 @@ implemented in the ``Solver.warm_up`` method, which is empty by default and
called after the `set_objective` method. For solvers with
``sampling_strategy`` in ``{'tolerance', 'iteration'}``, simply calling the
``Solver.run`` with a simple enough value is usually enough. For solvers with
``sampling_strategy`` set to ``'callback'``, it is possible to call
``sampling_strategy`` in ``{'callback', 'run_once'}``, it is possible to call
Copy link
Member

Choose a reason for hiding this comment

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

Not sure that this is really the right message?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why wouldn't that be the case?

Copy link
Member

@tomMoral tomMoral left a comment

Choose a reason for hiding this comment

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

LGTM!

@tomMoral tomMoral merged commit 8916e75 into benchopt:main Jun 5, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants