Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add retry_policy documentation
  • Loading branch information
PGijsbers committed May 3, 2021
commit 761ad9d7f76e4eef78ab0d01ac946bb7a396b3c1
1 change: 1 addition & 0 deletions doc/progress.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Changelog
0.12.2
~~~~~~

* ADD #1065: Add a ``retry_policy`` configuration option that determines the frequency and number of times to attempt to retry server requests.
* DOC: Fixes a few broken links in the documentation.
* MAINT/DOC: Automatically check for broken external links when building the documentation.
* MAINT/DOC: Fail documentation building on warnings. This will make the documentation building
Expand Down
9 changes: 7 additions & 2 deletions doc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,14 @@ which are separated by newlines. The following keys are defined:
* if set to ``True``, when ``run_flow_on_task`` or similar methods are called a lookup is performed to see if there already exists such a run on the server. If so, download those results instead.
* if not given, will default to ``True``.

* retry_policy:
* Defines how to react when the server is unavailable or experiencing high load. It determines both how often to attempt to reconnect and how quickly to do so. Please don't use ``human`` in an automated script that you run more than one instance of, it might increase the time to complete your jobs and that of others.
* human: For people running openml in interactive fashion. Try only a few times, but in quick succession.
* robot: For people using openml in an automated fashion. Keep trying to reconnect for a longer time, quickly increasing the time between retries.

* connection_n_retries:
* number of connection retries.
* default: 2. Maximum number of retries: 20.
* number of connection retries
* default depends on retry_policy (5 for ``human``, 50 for ``robot``)
Comment thread
PGijsbers marked this conversation as resolved.

* verbosity:
* 0: normal output
Expand Down