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 maxwidth : int, optional Printing width. output : file like object, optional File like object that the output is written to, default is toplevel : str, optional Start search at this level. |
---|
When used interactively with an object, np.info(obj)
is equivalent to help(obj)
on the Python prompt or obj?
on the IPython prompt.
>>> 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. ***
© 2008–2017 NumPy Developers
Licensed under the NumPy License.
https://docs.scipy.org/doc/numpy-1.14.2/reference/generated/numpy.info.html