Run this notebook online:Binder or Colab: Colab

2.7. 查阅文档

由于本书篇幅的限制,我们不可能介绍每一个 DJL 函数和类(你可能也不希望我们这样做)。API文档、其他教程和示例提供了本书之外的大量文档。在本节中,我们为你提供了一些查看 DJL API 的指导。

2.7.1. 查找模块中的所有函数和类

DJL javadoc文档 提供了常用模块的javadoc 链接,其中API 模块包含了DJL核心的类和函数。

我们可以在左侧的All Classes页面中查找感兴趣的类,点击类名,该类所有的函数及其说明会在主页面显示。

https://javadoc.io/doc/ai.djl/api/latest/ai/djl/ndarray/NDManager.html

2.7.2. 查找特定函数和类的用法

有关如何使用给定函数或类的更具体说明, 我们可以单击所需函数或通过搜索找到特定的函数。 举个例子,让我们探索一下NDManagerones函数的使用说明,该函数以Shape为参数。

https://javadoc.io/static/ai.djl/api/0.11.0/ai/djl/ndarray/NDManager.html#ones-ai.djl.ndarray.types.Shape-

从文档中,我们可以看到 ones 函数创建一个具有指定形状的新张量,并将所有元素值设置为 1。让我们来运行一个快速测试来确认这一解释:

%load ../utils/djl-imports
NDManager manager = NDManager.newBaseManager();
manager.ones(new Shape(4))
ND: (4) gpu(0) float32
[1., 1., 1., 1.]

2.7.3. 小结

  • DJL 官方文档提供了本书之外的大量描述和示例。

  • 我们可以访问 DJL 的 javadoc 查看API的用法。

2.7.4. 练习

  1. 在深度学习框架中查找任何函数或类的文档。你能在这个框架的官方网站上找到文档吗?