Строки документации по функциям отсутствуют в сети / pdf Описание API scipy.stats? - PullRequest
0 голосов
/ 07 сентября 2018

Я неправильно понимаю, как использовать документацию SciPy?

Я обнаружил, что я получаю гораздо менее подробную информацию о stats.gamma.fit из Справочной веб-страницы SciPy API / pdf, по крайней мере для scipy.stats , чем я делаю из stats.gamma.fit? на консоли Python. В частности, я не смог выяснить, как возвращаемое значение структурировано из Web / pdf API Reference, хотя он описывает себя как

Точный API всех функций и классов, указанный в строках документации. API документирует ожидаемые типы и разрешенные функции для всех функций, а также все параметры, доступные для алгоритмов.

Я также думаю, что существует противоречие между спецификацией, описанной в Web / pdf API Reference, и строкой документации консоли. В частности, в справочнике web / pdf говорится, что метод fit создает значение по умолчанию для параметров floc и fscale. Но строка документации с консоли гласит:

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

Я читаю это правильно?

1 Ответ

0 голосов
/ 07 сентября 2018

Как сказано в комментариях, метод 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.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...