Skip to content

Commit

Permalink
add warning to quad docs (#784)
Browse files Browse the repository at this point in the history
  • Loading branch information
mmahsereci authored Feb 17, 2023
1 parent 3c69e3b commit e17a258
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions src/probnum/quad/_bayesquad.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,12 @@ def bayesquad(
bayesquad_from_data : Computes the integral :math:`F` using a given dataset of
nodes and function evaluations.
Warnings
--------
Currently the method does not support tuning of the kernel parameters
other than the global kernel scale. Hence, the method may perform poorly unless the
kernel parameters are set to appropriate values by the user.
References
----------
.. [1] Briol, F.-X., et al., Probabilistic integration: A role in statistical
Expand Down Expand Up @@ -260,6 +266,12 @@ def bayesquad_from_data(
--------
bayesquad : Computes the integral using an acquisition policy.
Warnings
--------
Currently the method does not support tuning of the kernel parameters
other than the global kernel scale. Hence, the method may perform poorly unless the
kernel parameters are set to appropriate values by the user.
Examples
--------
>>> import numpy as np
Expand Down Expand Up @@ -383,6 +395,12 @@ def multilevel_bayesquad_from_data(
kernel instances, i.e., ``kernels[i] is kernel[j]`` must return ``False`` for any
:math:`i\neq j`.
Warnings
--------
Currently the method does not support tuning of the kernel parameters
other than the global kernel scale. Hence, the method may perform poorly unless the
kernel parameters are set to appropriate values by the user.
References
----------
.. [1] Li, K., et al., Multilevel Bayesian quadrature, AISTATS, 2023.
Expand Down

0 comments on commit e17a258

Please sign in to comment.