查阅 MXNet 文档

受篇幅所限,本书无法对所有用到的 MXNet 函数和类一一详细介绍。我们可以主动查找相关文档来做更深入的了解。

查找模块里的所有函数和类

当我们想知道一个模块(module)里面提供了哪些可以调用的函数和类的时候,可以使用dir函数。下面我们打印nd.random模块中所有的成员或属性。

In [1]:
from mxnet import nd

print(dir(nd.random))
['NDArray', '_Null', '__all__', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__spec__', '_internal', '_random_helper', 'current_context', 'exponential', 'gamma', 'generalized_negative_binomial', 'multinomial', 'negative_binomial', 'normal', 'numeric_types', 'poisson', 'shuffle', 'uniform']

通常我们可以忽略掉由__开头和结尾的函数(Python 的特别对象)或者由单_开头的函数(一般为内部函数)。通过其余成员的名字我们大致猜测出这个模块提供了各种随机数的生成方法,包括从均匀分布采样(uniform)、从正态分布采样(normal)、从泊松分布采样(poisson)等。

查找特定函数和类的使用

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

In [2]:
help(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)>

在 Jupyter 笔记本里,我们可以使用?来将文档显示在另外一个窗口中。例如nd.ones_like?将得到与help(nd.ones_like)几乎一样的内容,但会显示在额外窗口里。此外,如果使用两个nd.ones_like??,那么会额外显示该函数实现的代码。

在 MXNet 网站上查阅

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

MXNet官方网站(mxnet.apache.org)。点击顶部的下拉菜单“API”可查阅各个前端语言的API。在右上方含“Search”字样的搜索框中也可直接搜索API名称。

MXNet官方网站(mxnet.apache.org)。点击顶部的下拉菜单“API”可查阅各个前端语言的API。在右上方含“Search”字样的搜索框中也可直接搜索API名称。

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

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

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

小结

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

练习

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

扫码直达讨论区