bundles / numpy 2.4.4 / numpy / info
function
numpy:info
source: /numpy/lib/_utils_impl.py :421
Signature
def info ( object = None , maxwidth = 76 , output = None , toplevel = numpy ) Summary
Get help information for an array, function, class, or module.
Parameters
object: object or str, optionalInput object or name to get information about. If
objectis anndarrayinstance, information about the array is printed. Ifobjectis 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, optionalPrinting width.
output: file like object, optionalFile like object that the output is written to, default is
None, in which casesys.stdoutwill be used. The object has to be opened in 'w' or 'a' mode.toplevel: str, optionalStart 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
When using a string for `object` it is possible to get multiple results. When the argument is an array, information about the array is printed.a = np.array([[1 + 2j, 3, -4], [-5j, 6, 0]], dtype=np.complex64)
✓np.info(a)
✗Aliases
-
numpy.info