numpy.info

numpy.info(object=None, maxwidth=76, output=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='ANSI_X3.4-1968'>, toplevel='numpy') [source]

Получение справки по функции, классу или модулю.

Параметры:

object : object or str, optional Объект или имя для получения информации. Если object является объектом NumPy, возвращается его строка документации. Если это строка, ищутся соответствующие объекты в доступных модулях. Если None, возвращается информация об info самом. maxwidth : int, optional Ширина вывода. output : file like object, optional Объект типа файла, в который записывается вывод. По умолчанию stdout. Объект должен быть открыт в режиме ‘w’ или ‘a’. toplevel : str, optional Уровень поиска.

См. также

source, lookfor

Примечания

При интерактивном использовании с объектом, np.info(obj) эквивалентно help(obj) в командной строке Python или obj? в командной строке IPython.

Примеры

>>> np.info(np.polyval) 
   polyval(p, x)
     Evaluate the polynomial p at x.
     ...

При использовании строки для object могут быть получены несколько результатов.

>>> np.info('fft') 
     *** Found in numpy ***
Core FFT routines
...
     *** Found in numpy.fft ***
 fft(a, n=None, axis=-1)
...
     *** Repeat reference found in numpy.fft.fftpack ***
     *** Total of 3 references found. ***