[英]Function docstrings not on the web/pdf api reference scipy.stats?
我是否误解了如何使用SciPy文档?
我发现从SciPy API参考网页/ pdf中获得的关于stats.gamma.fit的详细信息要比从stats.gamma.fit获得的信息少得多(至少对于scipy.stats stats.gamma.fit?
在python控制台上。 特别是,我无法从web / pdf API参考中找到返回值的结构,即使它描述为
所有功能和类的确切API,由docstrings给出。 API记录了所有功能的预期类型和允许的功能,以及可用于算法的所有参数。
我还认为web / pdf API参考所描述的规范与控制台docstring之间存在矛盾。 具体而言,在网络/ PDF参考说, fit
方法产生的参数的缺省值floc
和fscale
。 但是控制台的文档字符串说,
kwds : floats, optional Starting values for the location and scale parameters; no default.
我读这些对吗?
如评论所述, fit
方法记录在rv_continuous
类中 ,特别是在此处 。 对于类的每个实例(例如gamma
,都不会重复此文档。
位置和比例参数的起始值; 没有默认值。
从技术上讲这是正确的,但在某种程度上具有误导性。 这意味着fit
方法签名fit(self, data, *args, **kwds)
不包含任何参数的默认值; 这里没有loc=0
,等等。
由于最小化器需要一些起始值,因此,如果用户未提供这些值,则可以通过调用内部方法_fitstart
来生成它们:
if (Narg < self.numargs) or not ('loc' in kwds and 'scale' in kwds):
start = self._fitstart(data)
可以将_fitstart
提供的值视为默认值,但就Python而言,它们不是默认参数值。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.