This is documentation for an old release of NumPy (version 1.15.1). Read this page in the documentation of the latest stable release (version > 1.17).
numpy.info¶
-
numpy.
info
(object=None, maxwidth=76, output=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='ANSI_X3.4-1968'>, toplevel='numpy')[source]¶ Get help information for a function, class, or module.
Parameters: - object : object or str, optional
Input object or name to get information about. If
object
is a numpy object, its docstring is given. If it is a string, available modules are searched for matching objects. If None, information aboutinfo
itself is returned.- maxwidth : int, optional
Printing width.
- output : file like object, optional
File like object that the output is written to, default is
stdout
. The object has to be opened in ‘w’ or ‘a’ mode.- toplevel : str, optional
Start search at this level.
Notes
When used interactively with an object,
np.info(obj)
is equivalent tohelp(obj)
on the Python prompt orobj?
on the IPython prompt.Examples
>>> np.info(np.polyval) polyval(p, x) Evaluate the polynomial p at x. ...
When using a string for
object
it is possible to get multiple results.>>> 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. ***