提交 6b0656ff authored 作者: Pascal Lamblin's avatar Pascal Lamblin

Update doc to reflect change regarding abs. and rel. tolerances

上级 0e9112d3
...@@ -363,11 +363,11 @@ at point ``x`` is approximated as: ...@@ -363,11 +363,11 @@ at point ``x`` is approximated as:
Here is the prototype for the verify_grad function. Here is the prototype for the verify_grad function.
>>> def verify_grad(op, pt, n_tests=2, rng=None, eps=1.0e-7, tol=0.0001): >>> def verify_grad(op, pt, n_tests=2, rng=None, eps=1.0e-7, abs_tol=0.0001, rel_tol=0.0001):
``verify_grad`` raises an Exception if the difference between the analytic gradient and ``verify_grad`` raises an Exception if the difference between the analytic gradient and
numerical gradient (computed through the Finite Difference Method) exceeds numerical gradient (computed through the Finite Difference Method) exceeds
the given tolerance. both the given absolute and relative tolerances.
The parameters are as follows: The parameters are as follows:
...@@ -383,7 +383,9 @@ The parameters are as follows: ...@@ -383,7 +383,9 @@ The parameters are as follows:
* eps: stepsize used in the Finite Difference Method * eps: stepsize used in the Finite Difference Method
* tol: relative tolerance used as threshold for gradient comparison * abs_tol: absolute tolerance used as threshold for gradient comparison
* rel_tol: relative tolerance used as threshold for gradient comparison
Here is an example showing how to use verify_grad: Here is an example showing how to use verify_grad:
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论