orion icon indicating copy to clipboard operation
orion copied to clipboard

Add a code "map" section to the developer documentation

Open abergeron opened this issue 1 year ago • 3 comments

This should be merged after #964 to make sure all the links will work correctly, which is why I publish it as a draft.

Otherwise it is mostly ready if you want to read and comment.

Checklist

Tests

The new pre-commit hook fails for unrelated files.

Documentation

  • [x] I have updated the relevant documentation related to my changes

Quality

  • [x] I have read the CONTRIBUTING doc
  • [x] My commits messages follow this format
  • [x] My code follows the style guidelines ($ tox -e lint)

abergeron avatar Jul 08 '22 19:07 abergeron

Thanks a lot for documentation the flow of execution during a call to orion hunt! I think it is quite complete, despite maybe a short mention of experiment version check/experiment creation race condition handling and a last section on termination criteria and how runners may exit (ex: broken experiment, completed experiment, reached max trials per worker).

bouthilx avatar Jul 14 '22 19:07 bouthilx

Sorry it took a lot of time, but I think I've addressed the comments now.

abergeron avatar Jul 22 '22 18:07 abergeron

I don't know what is wrong with tests/unittests/client/test_runner.py::test_runner_inside_dask, but I'm reasonably certain I didn't touch anything related to it and it keeps failing, but only on python 3.8.

abergeron avatar Jul 22 '22 21:07 abergeron