numpy.info — NumPy v1.11 Manual (original) (raw)
numpy.info(object=None, maxwidth=76, output=<open file '', mode 'w' at 0x402ae078>, 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 about info itself is returned. maxwidth : int, optional Printing width. output : file like object, optional File like object that the output is written to, default isstdout. 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 to help(obj) on the Python prompt or obj? 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. ***