文档教程人工智能深度学习NLP计算机视觉强化学习【免费下载链接】d2l-enInteractive deep learning book with multi-framework code, math, and discussions. Adopted at 500 universities from 70 countries including Stanford, MIT, Harvard, and Cambridge.项目地址https://gitcode.com/gh_mirrors/d2/d2l-en点击查看免费下载导读在使用 PyTorch、TensorFlow、MXNet 与 JAX 等深度学习框架进行开发时最大的障碍往往不是算法本身而是记不清某个函数叫什么、参数怎么传。本篇文章以《动手学深度学习》D2L预备知识章节中的lookup-api文档查阅一节为骨架系统讲解如何通过 Python 内置的dir与help工具快速定位框架模块中的函数与类、读懂其用法文档并结合仓库源码与d2l工具库的实际实现进行纵深拓展。读完本篇你将掌握一套不依赖搜索引擎的自给自足式 API 探索方法论能够在任何深度学习框架中快速查询、验证并复用函数与类。本文对应仓库文档位置为 chapter_preliminaries/lookup-api.md属于《动手学深度学习》预备知识章节的收尾小节与 ndarray.md数据操作、linear-algebra.md线性代数等章节共同构成后续学习的技术底座。为什么需要专门的查文档技能深度学习框架的 API 规模极为庞大官方文档虽然完备但存在两个现实问题信息更新快API 会随版本迭代频繁变化很多网上教程往往滞后于框架版本信息密度高官方文档追求全面覆盖但缺乏针对具体使用场景的指引。因此《动手学深度学习》在预备知识章节特意安排了这一节对应 chapter_preliminaries/index.md 中的lookup-api条目其核心观点是与其死记硬背每一个函数不如掌握一套主动探索 API 的方法。本节强调重要的使用场景优先于覆盖的完备性并鼓励读者在遇到问题时用dir快速浏览某个模块提供了哪些可调用的对象用help获取某个具体函数/类的详细用法用?/??在 Jupyter 中即时查看文档与源码最后通过实际运行一次小测试来验证自己的理解。这种先猜测、后验证、再实践的流程正是本节要传递给读者的核心方法论也是后续所有章节中高频使用的技能。多框架环境下的章节代码组织方式需要说明的是该章节在仓库中采用多框架并列的写法对应 chapter_preliminaries/lookup-api.md 开头通过tab.interact_select([mxnet, pytorch, tensorflow, jax])提供了 MXNet、PyTorch、TensorFlow 与 JAX 四种后端代码。各框架对应的导入语句分别为from mxnet import np # MXNet注意mxnet 已停止维护建议优先使用其余三种框架 import torch # PyTorch import tensorflow as tf # TensorFlow import jax # JAX这一设计贯穿全书仓库中的d2l工具包同样提供了四个后端实现文件分别为 d2l/mxnet.py、d2l/torch.py、d2l/tensorflow.py 与 d2l/jax.py其导入方式在 d2l/init.py 中有明确说明from d2l import mxnet as d2l # Use MXNet as the backend from d2l import torch as d2l # Use PyTorch as the backend from d2l import tensorflow as d2l # Use TensorFlow as the backend from d2l import jax as d2l # Use Jax as the backend无论你选择哪个后端本节介绍的dir与help用法都是通用的——这正是该技能价值所在方法论跨框架通用细节差异只需靠查询补齐。用dir探索模块先看有什么dir是 Python 的内置函数它返回对象所有属性的名字列表。在深度学习场景中最常见的用法是查询某个模块暴露了哪些函数与类。模块级探索以随机数模块为例原文档以随机数生成为例分别对四种框架的随机数模块执行了dir查询print(dir(np.random)) # MXNet print(dir(torch.distributions)) # PyTorch print(dir(tf.random)) # TensorFlow print(dir(jax.random)) # JAX以 PyTorch 的torch.distributions为例输出会包含诸如Uniform、Normal、Multinomial等分布类以及大量以__开头和结尾的特殊对象如__all__、__builtins__和以下划线开头的内部函数。如何解读dir的输出原文档给出了两条非常实用的过滤规则忽略以__开头和结尾的名字——这些是 Python 的特殊对象dunder 方法属于解释器内部机制如__init__、__repr__一般无需关注忽略以单个_开头的名字——这些通常是框架内部的私有函数虽然可以调用但不在公共 API 承诺范围内后续版本可能变更。过滤掉这两类名字后从剩余的函数名如uniform、normal、multinomial就可以合理推断该模块提供了从均匀分布、正态分布与多项分布中采样的方法。这种由命名推断功能的能力是快速上手新框架的重要技巧。从源码看dir的实际应用值得注意的是dir不仅能用于框架 API在仓库自身的d2l工具库实现中也被大量使用。例如在 d2l/mxnet.py 中HyperParameters与相关类通过dir(self)遍历对象的全部属性用于模型参数的收集与管理。而在 chapter_linear-classification/classification.md 的 MXNet 实现中get_scratch_params方法正是利用dir(self)遍历模型的所有属性再通过getattr取出那些是np.ndarray或d2l.Module的属性并汇总为参数列表d2l.add_to_class(d2l.Module) def get_scratch_params(self): params [] for attr in dir(self): a getattr(self, attr) if isinstance(a, np.ndarray): params.append(a) if isinstance(a, d2l.Module): params.extend(a.get_scratch_params()) return params这一真实案例说明dirgetattr的组合是深度学习中动态收集属性、参数与子模块的通用模式从框架探索到模型构建都离不开它。用help查看具体函数与类的用法dir回答模块里有什么而help回答某个函数怎么用。help是 Python 内置函数会输出对象的 docstring、参数签名、返回值等说明信息。原文档以张量的ones函数为例help(np.ones) # MXNet help(torch.ones) # PyTorch help(tf.ones) # TensorFlow help(jax.numpy.ones) # JAX从ones的文档中我们能读到什么以 PyTorch 的torch.ones为例help输出大致包含函数签名torch.ones(*size, *, outNone, dtypeNone, layouttorch.strided, deviceNone, requires_gradFalse)功能描述创建一个形状为size的新张量所有元素初始化为 1参数说明size可以是整数序列或torch.Sizedtype指定数据类型如torch.float32device指定张量所在设备CPU/GPUrequires_grad决定是否跟踪梯度示例代码多数框架文档会附带一两个最小的使用示例。阅读之后原文档强调的关键习惯是Whenever possible, you should run a quick test to confirm your interpretation——无论文档写得多么清楚都应该立刻跑一小段代码验证自己的理解是否正确。运行测试验证理解np.ones(4) # MXNet → array([1., 1., 1., 1.]) torch.ones(4) # PyTorch → tensor([1., 1., 1., 1.]) tf.ones(4) # TensorFlow → tf.Tensor([1. 1. 1. 1.], shape(4,), dtypefloat32) jax.numpy.ones(4) # JAX → Array([1., 1., 1., 1.], dtypefloat32)四种框架的ones(4)都创建了一个长度为 4、元素全为 1 的张量行为一致。这一小步验证的意义在于文档可能与版本存在偏差实际运行结果才是最可靠的事实依据。在 Jupyter 中使用?与??原文档还介绍了一个 Jupyter 特有的高效查询方式在 cell 中输入list?会在新窗口或弹出面板中显示与help(list)几乎相同的内容输入list??则额外显示该函数/类的 Python 源码实现。对于想要深入理解框架内部机制例如想知道torch.ones底层如何分配内存、list的append到底做了什么的读者来说??是比help更进一步的利器——它直接把实现代码摆在眼前。这也呼应了原文档的另一个重要建议鼓励读者研读所使用库的源码从中学习高质量生产代码的写法既能成为更好的工程师也能成为更好的科学家。官方文档之外的探索路径原文档明确指出本节的定位是提供如何探索 API 的引导而不是替代官方文档——官方文档提供了远超本书范围的大量描述与示例。同时它还给出了两条延伸建议查阅官方 API 文档与教程各框架的官方文档是权威来源遇到书中未覆盖的函数应优先查阅阅读库的源码源码是最忠实的文档??或直接浏览 GitHub 仓库都是可行的方式。在本书仓库中这一建议同样适用d2l工具包的全部实现都以明文 Python 源码的形式存放在 d2l/ 目录下例如 d2l/torch.py 中定义了Module模型基类包含forward、training_step、validation_step、configure_optimizers等方法、DataModule数据基类提供train_dataloader与val_dataloader、Trainer训练器等贯穿全书的核心抽象。读者可以直接阅读这些文件观察save_hyperparameters如何借助inspect模块自动保存超参数或者ProgressBoard如何实现训练过程的动态绘图——这正是从源码学习工程实践的最佳范例。仓库中的API 文档资源更进一步本书还在 chapter_appendix-tools-for-deep-learning/d2l.md 中提供了完整的d2l包 API 文档页按字母序列出了d2l.torch/d2l.mxnet中的全部类如Module、Trainer、LeNet、RNN、TransformerEncoder等与函数如add_to_class、corr2d、try_gpu、masked_softmax等并标注了每个符号在书中对应章节的位置方便读者反向定位详细实现。这份官方文档本身就是使用dir/help方法论的成果展示。组合技能一套完整的 API 探索工作流将上面的工具组合起来就形成了一套在任何深度学习框架中都通用的 API 探索工作流步骤工具解决的问题示例1. 浏览模块dir(module)这个模块提供了哪些函数/类dir(torch.distributions)2. 过滤噪音命名规则哪些是公共 API忽略__x__与_x前缀3. 查看细节help(func)函数签名、参数与返回值help(torch.ones)4. 查看源码func??内部是如何实现的torch.ones??5. 运行验证一行代码我的理解是否正确torch.ones(4)这套流程正是本节标题lookup-api查询 API的完整内涵。无论日后切换框架、升级版本还是使用从未接触过的新库这套方法论都能让你快速站稳脚跟。小结dir用于探索模块提供了哪些可调用对象解读时过滤掉__包围的特殊对象和单下划线开头的内部对象剩余的函数名通常足以推断模块功能help用于查看具体函数/类的详细用法包括签名、参数与返回值说明Jupyter 中的?显示文档、??额外显示源码实现是快速深入细节的利器无论文档如何详尽都应通过一次实际运行来验证理解官方文档追求覆盖面本书则聚焦高频使用场景两者结合再加上对库源码的研读是成为更好的工程师与科学家的有效路径。本节内容位于 chapter_preliminaries/lookup-api.md是预备知识章节chapter_preliminaries/index.md中关于存储数据、处理数据、线性代数、微积分、自动求导、概率论之外的最后一项生存技能——当你在学习过程中遇到任何陌生的 API随时回到这里用dir与help找到答案。赞分享文档教程人工智能深度学习NLP计算机视觉强化学习【免费下载链接】d2l-enInteractive deep learning book with multi-framework code, math, and discussions. Adopted at 500 universities from 70 countries including Stanford, MIT, Harvard, and Cambridge.项目地址https://gitcode.com/gh_mirrors/d2/d2l-en点击查看免费下载相关推荐《动手学深度学习》查阅文档用 dir、help 与 ?/?? 高效探索深度学习框架 API《动手学深度学习》查阅文档用 dir、help 与 ?/?? 高效探索深度学习框架 API 深度学习框架PyTorch、TensorFlow、MXNet、P人工智能深度学习机器学习教程《动手学深度学习》API 查阅指南用 dir、help 与 Jupyter 魔法符号快速定位框架文档《动手学深度学习》API 查阅指南用 dir、help 与 Jupyter 魔法符号快速定位框架文档 本文是《动手学深度学习》d2l zh预备知识章的收尾人工智能深度学习机器学习教程BVLC/Caffe深度学习框架入门教程从零开始掌握经典深度学习框架BVLC/Caffe深度学习框架入门教程从零开始掌握经典深度学习框架 还在为深度学习框架的复杂性而头疼想要快速上手一个稳定、高效的深度学习框架BVLC/C深度学习计算机视觉创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考