功能文档字符串不在网络/ pdf api参考scipy.stats上吗?

时间:2018-09-07 16:18:21

标签: python scipy

我是否误解了如何使用SciPy文档?

我发现从the SciPy API Reference webpage/pdf, at least for scipy.stats获得的有关stats.gamma.fit的信息比在python控制台上获得的stats.gamma.fit?少得多。特别是,我无法从web / pdf API参考中找到返回值的结构,即使该返回值将自身描述为

  

所有功能和类的确切API,由文档字符串提供。该API记录了所有功能的预期类型和允许的功能,以及算法可用的所有参数。

我还认为web / pdf API参考所描述的规范与控制台文档字符串之间存在矛盾。具体而言,web / pdf参考资料指出fit方法为参数flocfscale产生一个默认值。但是控制台的文档字符串说,

  

kwds : floats, optional Starting values for the location and scale parameters; no default.

我没看错吗?

1 个答案:

答案 0 :(得分:1)

如评论中所述,方法fit记录在rv_continuous class中,尤其是here中。对于类的每个实例(例如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的角度来看,它们不是默认参数值。