A Python-based toolbox of various methods in decision making, uncertainty quantification and statistical emulation: multi-fidelity, experimental design, Bayesian optimisation, Bayesian quadrature, etc.
Description of changes:
This PR looks scary, but let me explain (all changes only involve the quadrature package):
I finally fixed all docstrings in quadrature as they were incomplete, partially wrong, did not render correctly, or did not adhere to the right formatting. Things look pretty and informative now.
I moved a few imports one level up. It's way more intuitive now. (e.g. instead of from emukit.quadrature.loop.specific_loop_name import SpecificLoop we now have from emukit.quadrature.loop import SpecificLoop etc). The latter imports were possible before already in most places, so it's more of a "hiding away" of the lengthy versions of it and making it consistent. Actual imports in code will only break occasionally in case the lengthy version was used. I think it's way more user-friendly like this. There might be other ways of doing this though.
Some objects got their own submodule as it made sense. These are emukit.quadrature.kernels.measures for integration measures and emukit.quadrature.loop.point_calculators for quadrature specific point calculator.
Renamed BoxBounds to BoxDomain. This object is only used internally, so should not interfere with much.
Functionality of the code is unchanged. So this PR is just cosmetics, albeit a bit overdue...
@apaleyes perhaps you can check how the docs look. I hope the changes in module/import structure are OK for the quad package considering that it's easier to parse now for users. But let me know what you think.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Issue #, if available:
Description of changes: This PR looks scary, but let me explain (all changes only involve the
quadraturepackage):quadratureas they were incomplete, partially wrong, did not render correctly, or did not adhere to the right formatting. Things look pretty and informative now.from emukit.quadrature.loop.specific_loop_name import SpecificLoopwe now havefrom emukit.quadrature.loop import SpecificLoopetc). The latter imports were possible before already in most places, so it's more of a "hiding away" of the lengthy versions of it and making it consistent. Actual imports in code will only break occasionally in case the lengthy version was used. I think it's way more user-friendly like this. There might be other ways of doing this though.emukit.quadrature.kernels.measuresfor integration measures andemukit.quadrature.loop.point_calculatorsfor quadrature specific point calculator.BoxBoundstoBoxDomain. This object is only used internally, so should not interfere with much.@apaleyes perhaps you can check how the docs look. I hope the changes in module/import structure are OK for the quad package considering that it's easier to parse now for users. But let me know what you think.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.