[SciPy-Dev] Doc error in scipy.optimize.fmin and missing info in ref guide

[David Goldsmith]

I'll look into both problems.

DG

On Mon, Mar 15, 2010 at 4:13 PM, <josef.pktd at gmail.com> wrote:

> On Mon, Mar 15, 2010 at 7:05 PM, Rob Clewley <rob.clewley at gmail.com>
> wrote:
> > Hi,
> >
> > In both my old version and the one in the svn trunk there is an
> > inconsistency in the docstring of scipy.optimize.fmin.
> >
> >    Other Parameters
> >    ----------------
> >    xtol : float
> >        Relative error in xopt acceptable for convergence.
> >    ftol : number
> >        Relative error in func(xopt) acceptable for convergence.
> >
> > As you see from the following code snippet from the body of the
> > function, the convergence test is in terms of absolute error for both
> > x and f, as the sim array contains x values and fsim the function
> > values.
> >
> >    if (max(numpy.ravel(abs(sim[1:]-sim[0]))) <= xtol \
> >                and max(abs(fsim[0]-fsim[1:])) <= ftol):
> >        break
> >
> > Also, optional parameters for any optimize functions are not described
> > in the draft of the Scipy reference manual I came across while
> > googling this issue. For instance, at
> >
> >
> http://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.fmin.html#scipy.optimize.fmin
> >
> > fmin does not have the optional arguments detailed. If this is
> > automatically generated is there a reason why the optional parameters
> > aren't being shown in this document? I think they should be, IMO.
>
> just a guess:
>
> http://docs.scipy.org/scipy/docs/scipy.optimize.optimize.fmin/
>
> shows that Other Parameters is in the wrong order. It could be that
> the section is ignored for rendering the html for this reason
>
> Josef
>
>
> >
> > -Rob
> > _______________________________________________
> > SciPy-Dev mailing list
> > SciPy-Dev at scipy.org
> > http://mail.scipy.org/mailman/listinfo/scipy-dev
> >
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev at scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20100315/adfcf91b/attachment.html>