如何使用 PyCharm 和 Pytorch 快速获取文档答案

【问题标题】：How to get quick documentation working with PyCharm and Pytorch如何使用 PyCharm 和 Pytorch 快速获取文档
【发布时间】：2020-04-27 02:06:14
【问题描述】：

我在 Windows 10 上运行 PyCharm，并按照入门指南安装了 PyTorch。我使用Chocolatey 和 Anaconda 来设置一切。

我可以在 PyCharm IDE 中运行 PyTorch 教程，没有任何问题。所以我觉得我的设置正确，但没有任何 PyTorch API 的智能感知文档。

例如；

import torch

x = torch.randn(128, 20)

如果我将鼠标悬停在 randn 上并按下 CTRL+Q，那么 PyCharm 会显示一个函数定义的弹出窗口，而无需任何文档。

我希望从该函数的 API 文档中看到 Python cmets：

我是 Pytorch 和 Python 的新手，但我经常可以从 IDE 内部使用许多其他语言和库访问这些内容。所以我觉得这应该可以开始工作，但我似乎找不到任何关于如何解决这个问题的说明。

【问题讨论】：

【解决方案1】：

您可能想获得Kite。它有一个称为 co-pilot 的功能（我经常使用），您可以在其中立即获取 python 文档。我不知道它是否特定于 Linux/Mac 但适用于任何编辑器，仅适用于 Pycharm。

_{这只是另一种解决方案}

【讨论】：

【解决方案2】：

我能够通过执行以下操作使其正常工作：

PyStorm 2019.3

打开外部文档的设置：

文件/设置/工具/外部文档

添加以下 URL 模式：

Module Name: torch.nn.functional
        URL: https://pytorch.org/docs/stable/nn.functional.html#{element.qname}

Module Name: torch
        URL: https://pytorch.org/docs/stable/{module.basename}.html#{element.qname}

似乎适用于大多数 API，但您必须触发快速文档工具窗口。如果您 CTRL+CLICK 某事，这将不会显示文档。

【讨论】：