查阅 MXNet 文档

受篇幅所限,本书无法对所有 MXNet 的应用程序接口(API)一一介绍。每当遇到不熟悉的 MXNet API 时,我们可以主动查阅它的相关文档。

使用 dir 函数

我们可以使用 dir 函数查阅 API 中包含的成员或属性。打印 autograd 模块中所有的成员或属性。

In [1]:
from mxnet import autograd
print(dir(autograd))
['CFUNCTYPE', 'Function', 'Lock', 'MXCallbackList', 'NDArray', 'NDArrayHandle', 'POINTER', 'Symbol', 'SymbolHandle', '_GRAD_REQ_MAP', '_LIB', '_RecordingStateScope', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', '_ndarray_cls', '_parse_head', 'absolute_import', 'array', 'backward', 'c_array', 'c_array_buf', 'c_handle_array', 'c_int', 'c_void_p', 'cast', 'check_call', 'ctypes', 'division', 'get_symbol', 'grad', 'is_recording', 'is_training', 'mark_variables', 'mx_uint', 'pause', 'predict_mode', 'record', 'set_recording', 'set_training', 'string_types', 'traceback', 'train_mode']

使用 help 函数

当我们想了解 API 的具体用法时,可以使用 help 函数。让我们以 NDArray 中的 ones_like 函数为例,查阅它的用法。

In [2]:
from mxnet import nd
help(nd.ones_like) # 在 Jupyter notebook 中可使用问号查询,例如 nd.ones_like?
Help on function ones_like:

ones_like(data=None, out=None, name=None, **kwargs)
    Return an array of ones with the same shape and type
    as the input array.

    Examples::

      x = [[ 0.,  0.,  0.],
           [ 0.,  0.,  0.]]

      ones_like(x) = [[ 1.,  1.,  1.],
                      [ 1.,  1.,  1.]]



    Parameters
    ----------
    data : NDArray
        The input

    out : NDArray, optional
        The output NDArray to hold the result.

    Returns
    -------
    out : NDArray or list of NDArrays
        The output of this function.

从文档信息我们了解到,ones_like 函数会创建和输入 NDArray 形状相同且元素为 1 的新的 NDArray。我们可以验证一下:

In [3]:
x = nd.array([[0,0,0], [2,2,2]])
y = x.ones_like()
y
Out[3]:

[[ 1.  1.  1.]
 [ 1.  1.  1.]]
<NDArray 2x3 @cpu(0)>

在 MXNet 网站上查阅

我们也可以在 MXNet 的网站上查阅 API 的相关文档。访问 MXNet 网站(mxnet.apache.org)。如图 2.1 所示,点击网页顶部的下拉菜单“API”可查阅各个前端语言的 API。此外,我们也可以在网页右上方含“Search”字样的搜索框中直接搜索 API 名称。

图 2.2 展示了 MXNet 网站上有关 ones_like 函数的文档。

MXNet 网站上有关 ``ones_like`` 函数的文档。

MXNet 网站上有关 ones_like 函数的文档。

小结

  • 每当遇到不熟悉的 MXNet API 时,我们可以主动查阅它的相关文档。
  • 查阅 MXNet 文档可以使用 dirhelp 函数,或访问 MXNet 官网。

练习

  • 查阅 NDArray 支持的其他操作。

扫码直达 讨论区