PyTorch查看模块/类的所有方法/属性
PyTorch 是一个非常庞大且功能丰富的深度学习框架。要在一篇文章里列出所有的 API 是不现实的（官方文档有数千页），但我可以为你提供一个系统性的、结构化的指南，告诉你如何查看和理解所有 PyTorch 的模块、方法、函数及其参数说明，特别是如何高效地利用中文帮助资源。
核心查看方法：官方文档
无论中英文，最权威、最全面、最及时的信息来源永远是 官方文档。
1. 英文官方文档（最新最全）
-
网址: https://pytorch.org/docs/stable/index.html
-
特点:
-
版本稳定：
stable指向当前最新的稳定版（如 2.0+）。你还可以查看nightly（每日构建版）或指定历史版本。 -
结构清晰：左侧有完整的导航栏，按模块分类。
-
可搜索：顶部有搜索框，可以直接搜索函数或类名。
-
包含代码示例：几乎所有重要的函数和类都提供了用法示例，这是最重要的学习资料。
-
参数说明详尽：每个参数的类型、含义、默认值都解释得非常清楚。
-
主要模块分类（在文档左侧导航栏中）:
| 模块名称 | 主要内容 |
|---|---|
| TORCH | 核心张量库，包含数学运算、随机数、序列化、CUDA功能等。例如 torch.add, torch.mm, torch.save, torch.cuda.is_available |
| TORCH.NN | 神经网络核心模块。这是最常用的部分。 |
→ nn.Module | 所有神经网络模块的基类。你的模型必须继承这个类。 |
→ nn.functional (F) | 包含各种无需参数的函数式操作，如激活函数 (relu, sigmoid)、损失函数 (mse_loss)、卷积/池化操作等。 |
→ nn.init | 权重初始化的函数，如 kaiming_normal_, xavier_uniform_。 |
→ nn.utils | 实用工具，如 nn.utils.rnn.pack_padded_sequence（用于RNN），nn.utils.clip_grad_norm_（梯度裁剪）。 |
| TORCH.OPTIM | 优化算法库。如 optim.SGD, optim.Adam, optim.Adagrad。 |
| TORCH.UTILS.DATA | 数据加载工具。核心类是 Dataset（定义数据集）和 DataLoader（生成可迭代的数据批量）。 |
| TORCHVISION | （独立库）处理图像和视频的常用数据集、模型和变换。如 torchvision.datasets, torchvision.models, torchvision.transforms。 |
| TORCHAUDIO | （独立库）处理音频的库。 |
| TORCHTEXT | （独立库）处理文本的库。 |
2. 在Python中直接查看（Jupyter Notebook / IPython）
这是最快捷的日常查询方式，使用 ? 或 help()。
-
查看模块/类的所有方法/属性:
python
import torch import torch.nn as nn# 查看torch.nn模块下所有内容 print(dir(nn))# 查看Linear类的所有方法 print(dir(nn.Linear))
-
查看函数/类的详细文档（Docstring）:
python
# 方法 1: 使用 ? （在Jupyter Notebook中最佳） ?nn.Linear # 或 ?torch.optim.Adam# 方法 2: 使用 help() help(nn.Linear)
-
查看函数签名和源代码（更高级）:
python
# 查看函数签名（需要参数） import inspect print(inspect.signature(torch.arange))# 查看源代码（如果是用Python实现的） ??nn.Linear # 在Jupyter中 # 或 import inspect print(inspect.getsource(nn.Linear.forward)) # 查看forward方法的源码
中文帮助资源
虽然官方英文文档是首选，但也有一些不错的中文资源可供参考和入门。
1. PyTorch 官方中文文档（部分）
-
网址: https://pytorch.apachecn.org
-
特点:
-
由 ApacheCN 社区翻译和维护。
-
注意: 翻译可能滞后于官方英文版本，一些最新的API可能没有及时更新。强烈建议将其作为入门参考，但在遇到版本问题时务必核对英文原版文档。
-
2. 中文教程和资源站
-
PyTorch 中文教程（PyTorchChina官方提供）:
-
内容质量高，但可能不是完整的API文档，而是精选的教程。
-
可以关注 PyTorch 官方微信公众号或知乎账号获取信息。
-
-
莫烦Python PyTorch 教程:
-
非常适合初学者的视频和图文教程，涵盖了从基础到进阶的很多概念。
-
网址: https://mofanpy.com/tutorials/machine-learning/torch/
-
-
其他优秀中文博客和GitHub项目:
-
很多机器学习领域的博主（如”夕小瑶“、”刘聪NLP“等）会写非常高质量的PyTorch源码解析和实战文章。
-
在GitHub上搜索
pytorch-tutorial,pytorch-handbook等关键词，可以找到很多开源的学习资源。
-
在 PyCharm 中查看方法
PyCharm 被公认为最好的 Python IDE 之一，其开箱即用的智能感知功能非常强大。
1. 查看参数信息 (Parameter Info)
当你在输入一个函数或方法时，PyCharm 会自动弹出参数提示。
-
快捷键: 在函数名后的括号内按
Ctrl + P(Windows/Linux) 或Cmd + P(Mac)。 -
效果: 会显示所有参数的名称和类型。将光标悬停在某个参数上会显示该参数的详细说明。
示例：输入 torch.arange( 后立即按 Ctrl+P
2. 查看快速文档 (Quick Documentation)
随时随地查看任何函数、类或变量的文档字符串（Docstring）。
-
快捷键: 将鼠标悬停在代码上，就会自动弹出一个小窗口显示文档。点击窗口中的链接可以展开查看更多。
-
更详细查看: 在代码中按住
Ctrl + Q(Windows/Linux) 或Ctrl + J(Mac)，会在右侧或下方打开一个固定的文档面板。
示例：将鼠标悬停在 nn.Linear 上。
3. 跳转到定义 (Go to Definition)
这是理解源码和库结构的终极武器。你可以直接跳转到 PyTorch 任何一个类或函数的源代码定义处。
-
快捷键: 按住
Ctrl键 (Windows/Linux) 或Cmd键 (Mac)，然后用鼠标点击函数/类名。 -
或者: 将光标放在目标上，按
Ctrl + B(Windows/Linux) 或Cmd + B(Mac)。
示例：按住 Ctrl 并点击 nn.Module，你会直接跳转到 torch/nn/modules/module.py 文件中该类的定义。你可以看到它的所有方法、属性和详细的注释。
4. 查看用法 (Find Usages)
想知道一个函数在项目中是如何被使用的？这个功能可以帮你快速学习。
-
快捷键: 将光标放在目标上，按
Alt + F7。 -
效果: PyCharm 会在底部窗口列出项目中所有使用了该函数/类的地方。
实战示例：如何研究一个陌生的API
假设你现在想了解 nn.Transformer 这个类。
-
第一步：官方文档
-
打开 PyTorch Docs。
-
在左侧导航栏找到
torch.nn->Transformer，点击进入。 -
或者直接在顶部搜索框搜索
Transformer。
-
-
第二步：阅读文档
-
顶部: 你会看到
CLASS torch.nn.Transformer(...)，这就是它的构造函数。 -
Parameters: 下面会详细列出所有初始化参数，如
d_model（词嵌入维度）、nhead（注意力头数量）、num_encoder_layers（编码器层数）等。每个参数都有类型和解释。 -
Shape: 会说明输入张量和输出张量的形状要求，这对于调试至关重要。
-
Examples: 一定要看！ 这里会提供最少代码示例，告诉你如何创建和使用一个Transformer模型。
-
Methods: 会列出这个类的主要方法，如
forward,generate等，每个方法点进去都有同样的详细说明。
-
-
第三步：在代码中验证（可选）
python
# 在Jupyter中快速查看 ?nn.Transformer# 或者直接跳转到源码查看大致结构（在IDE如PyCharm/VSCode中按住Ctrl点击类名）
总结
-
首选英文官方文档：它是准确性和时效性的保证。不要害怕英文，技术文档的词汇相对固定，多看几次就熟悉了。
-
善用IDE的智能提示和跳转：PyCharm、VSCode（配合Python插件）可以自动提示函数参数、类型，并且能跳转到定义，极大提升效率。
-
中文资源作为辅助：在入门阶段，中文教程和文档可以帮助你快速理解概念。但在做项目或研究时，一定要以英文文档为准，避免因版本过时而产生错误。