Skip to content

Commit e17a258

Browse files
authored
add warning to quad docs (#784)
1 parent 3c69e3b commit e17a258

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

src/probnum/quad/_bayesquad.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,12 @@ def bayesquad(
156156
bayesquad_from_data : Computes the integral :math:`F` using a given dataset of
157157
nodes and function evaluations.
158158
159+
Warnings
160+
--------
161+
Currently the method does not support tuning of the kernel parameters
162+
other than the global kernel scale. Hence, the method may perform poorly unless the
163+
kernel parameters are set to appropriate values by the user.
164+
159165
References
160166
----------
161167
.. [1] Briol, F.-X., et al., Probabilistic integration: A role in statistical
@@ -260,6 +266,12 @@ def bayesquad_from_data(
260266
--------
261267
bayesquad : Computes the integral using an acquisition policy.
262268
269+
Warnings
270+
--------
271+
Currently the method does not support tuning of the kernel parameters
272+
other than the global kernel scale. Hence, the method may perform poorly unless the
273+
kernel parameters are set to appropriate values by the user.
274+
263275
Examples
264276
--------
265277
>>> import numpy as np
@@ -383,6 +395,12 @@ def multilevel_bayesquad_from_data(
383395
kernel instances, i.e., ``kernels[i] is kernel[j]`` must return ``False`` for any
384396
:math:`i\neq j`.
385397
398+
Warnings
399+
--------
400+
Currently the method does not support tuning of the kernel parameters
401+
other than the global kernel scale. Hence, the method may perform poorly unless the
402+
kernel parameters are set to appropriate values by the user.
403+
386404
References
387405
----------
388406
.. [1] Li, K., et al., Multilevel Bayesian quadrature, AISTATS, 2023.

0 commit comments

Comments
 (0)