[英]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.