adding changes to docs

emukit/quadrature/loop/__init__.py

@@ -12,12 +12,18 @@
 
 
 from .bayesian_monte_carlo_loop import BayesianMonteCarlo  # noqa: F401
+from .bq_loop_state import QuadratureLoopState
+from .bq_outer_loop import QuadratureOuterLoop
+from .bq_stopping_conditions import CoefficientOfVariationStoppingCondition
 from .vanilla_bq_loop import VanillaBayesianQuadratureLoop  # noqa: F401
 from .wsabil_loop import WSABILLoop  # noqa: F401
 
 __all__ = [
+    "QuadratureOuterLoop",
     "BayesianMonteCarlo",
     "VanillaBayesianQuadratureLoop",
     "WSABILLoop",
+    "QuadratureLoopState",
     "point_calculators",
+    "CoefficientOfVariationStoppingCondition",
 ]

emukit/quadrature/loop/bayesian_monte_carlo_loop.py

@@ -8,14 +8,15 @@
 # Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-from ...core.loop import FixedIntervalUpdater, ModelUpdater, OuterLoop
-from ...core.loop.loop_state import create_loop_state
+from ...core.loop import FixedIntervalUpdater, ModelUpdater
 from ...core.parameter_space import ParameterSpace
 from ..loop.point_calculators import BayesianMonteCarloPointCalculator
 from ..methods import WarpedBayesianQuadratureModel
+from .bq_loop_state import create_bq_loop_state
+from .bq_outer_loop import QuadratureOuterLoop
 
 
-class BayesianMonteCarlo(OuterLoop):
+class BayesianMonteCarlo(QuadratureOuterLoop):
     """The loop for Bayesian Monte Carlo (BMC).
 
 
@@ -61,7 +62,7 @@ def __init__(self, model: WarpedBayesianQuadratureModel, model_updater: ModelUpd
 
         space = ParameterSpace(model.reasonable_box_bounds.convert_to_list_of_continuous_parameters())
         candidate_point_calculator = BayesianMonteCarloPointCalculator(model, space)
-        loop_state = create_loop_state(model.X, model.Y)
+        loop_state = create_bq_loop_state(model.X, model.Y)
 
         super().__init__(candidate_point_calculator, model_updater, loop_state)
 

emukit/quadrature/loop/bq_loop_state.py

@@ -10,8 +10,8 @@
 from ...core.loop.user_function_result import UserFunctionResult
 
 
-class BQLoopState(LoopState):
-    """Contains the state of the BQ loop, which includes a history of all function evaluations and integral mean and
+class QuadratureLoopState(LoopState):
+    """Contains the state of the BQ loop, which includes a history of all integrand evaluations and integral mean and
     variance estimates.
 
     :param initial_results: The results from previous integrand evaluations.
@@ -35,7 +35,7 @@ def update_integral_stats(self, integral_mean: float, integral_var: float) -> No
         self.integral_vars.append(integral_var)
 
 
-def create_bq_loop_state(x_init: np.ndarray, y_init: np.ndarray, **kwargs) -> BQLoopState:
+def create_bq_loop_state(x_init: np.ndarray, y_init: np.ndarray, **kwargs) -> QuadratureLoopState:
     """Creates a BQ loop state object using the provided data.
 
     :param x_init: x values for initial function evaluations. Shape: (n_initial_points x n_input_dims)
@@ -45,4 +45,4 @@ def create_bq_loop_state(x_init: np.ndarray, y_init: np.ndarray, **kwargs) -> BQ
     """
 
     loop_state = create_loop_state(x_init, y_init, **kwargs)
-    return BQLoopState(loop_state.results)
+    return QuadratureLoopState(loop_state.results)

emukit/quadrature/loop/bq_outer_loop.py

@@ -7,11 +7,11 @@
 from ...core.loop import OuterLoop
 from ...core.loop.candidate_point_calculators import CandidatePointCalculator
 from ...core.loop.model_updaters import ModelUpdater
-from .bq_loop_state import BQLoopState
+from .bq_loop_state import QuadratureLoopState
 
 
-class BQOuterLoop(OuterLoop):
-    """Base class for a Bayesian quadrature outer loop.
+class QuadratureOuterLoop(OuterLoop):
+    """Base class for a Bayesian quadrature loop.
 
     :param candidate_point_calculator: Finds next point(s) to evaluate.
     :param model_updaters: Updates the model with the new data and fits the model hyper-parameters.
@@ -26,7 +26,7 @@ def __init__(
         self,
         candidate_point_calculator: CandidatePointCalculator,
         model_updaters: Union[ModelUpdater, List[ModelUpdater]],
-        loop_state: BQLoopState = None,
+        loop_state: QuadratureLoopState = None,
     ):
         if isinstance(model_updaters, list):
             raise ValueError("The BQ loop only supports a single model.")

emukit/quadrature/loop/bq_stopping_conditions.py

@@ -7,7 +7,7 @@
 import numpy as np
 
 from ...core.loop.stopping_conditions import StoppingCondition
-from .bq_loop_state import BQLoopState
+from .bq_loop_state import QuadratureLoopState
 
 _log = logging.getLogger(__name__)
 
@@ -20,7 +20,7 @@ class CoefficientOfVariationStoppingCondition(StoppingCondition):
     .. math::
         COV = \frac{\sigma}{\mu}
 
-    with :math:`\mu` and :math:`\sigma^2` the current mean and standard deviation of integral according to the
+    where :math:`\mu` and :math:`\sigma^2` are the current mean and standard deviation of integral according to the
     BQ posterior model.
 
     :param eps: Threshold under which the COV must fall.
@@ -37,7 +37,7 @@ def __init__(self, eps: float, delay: int = 1) -> None:
         self.delay = delay
         self.times_true = 0  # counts how many times stopping had been triggered in a row
 
-    def should_stop(self, loop_state: BQLoopState) -> bool:
+    def should_stop(self, loop_state: QuadratureLoopState) -> bool:
         if len(loop_state.integral_means) < 1:
             return False
 

emukit/quadrature/loop/vanilla_bq_loop.py

@@ -12,10 +12,10 @@
 from ..acquisitions import IntegralVarianceReduction
 from ..methods import VanillaBayesianQuadrature
 from .bq_loop_state import create_bq_loop_state
-from .bq_outer_loop import BQOuterLoop
+from .bq_outer_loop import QuadratureOuterLoop
 
 
-class VanillaBayesianQuadratureLoop(BQOuterLoop):
+class VanillaBayesianQuadratureLoop(QuadratureOuterLoop):
     """The loop for standard ('vanilla') Bayesian Quadrature.
 
     .. seealso::

emukit/quadrature/loop/wsabil_loop.py

@@ -11,10 +11,10 @@
 from ..acquisitions import UncertaintySampling
 from ..methods import WSABIL
 from .bq_loop_state import create_bq_loop_state
-from .bq_outer_loop import BQOuterLoop
+from .bq_outer_loop import QuadratureOuterLoop
 
 
-class WSABILLoop(BQOuterLoop):
+class WSABILLoop(QuadratureOuterLoop):
     """The loop for WSABI-L.
 
     .. rubric:: References