评价此页

★ ★ ★ ★ ★

advanced/cpp_autograd

在 Google Colab 中运行

C++ 前端中的 Autograd#

创建日期：2020年4月1日 | 最后更新：2025年1月21日 | 最后验证：未验证

autograd 包对于在 PyTorch 中构建高度灵活和动态的神经网络至关重要。PyTorch Python 前端中的大多数 autograd API 在 C++ 前端中也可用，可以轻松地将 autograd 代码从 Python 翻译到 C++。

在本教程中，我们将探讨在 PyTorch C++ 前端中使用 autograd 的几个示例。请注意，本教程假定您已经对 Python 前端中的 autograd 有了基本的了解。如果不是这样，请先阅读 Autograd：自动微分。

基本 autograd 操作#

(改编自此教程)

创建一个张量并设置 torch::requires_grad() 来跟踪其中的计算

auto x = torch::ones({2, 2}, torch::requires_grad());
std::cout << x << std::endl;

输出

1 1
1 1
[ CPUFloatType{2,2} ]

执行张量操作

auto y = x + 2;
std::cout << y << std::endl;

输出

 3  3
 3  3
[ CPUFloatType{2,2} ]

y 是作为操作结果创建的，因此它有一个 grad_fn。

std::cout << y.grad_fn()->name() << std::endl;

输出

AddBackward1

对 y 执行更多操作

auto z = y * y * 3;
auto out = z.mean();

std::cout << z << std::endl;
std::cout << z.grad_fn()->name() << std::endl;
std::cout << out << std::endl;
std::cout << out.grad_fn()->name() << std::endl;

输出

 27  27
 27  27
[ CPUFloatType{2,2} ]
MulBackward1
27
[ CPUFloatType{} ]
MeanBackward0

.requires_grad_(...) 会就地更改现有张量的 requires_grad 标志。

auto a = torch::randn({2, 2});
a = ((a * 3) / (a - 1));
std::cout << a.requires_grad() << std::endl;

a.requires_grad_(true);
std::cout << a.requires_grad() << std::endl;

auto b = (a * a).sum();
std::cout << b.grad_fn()->name() << std::endl;

输出

false
true
SumBackward0

现在我们进行反向传播。因为 out 包含一个标量，所以 out.backward() 等同于 out.backward(torch::tensor(1.))。

out.backward();

打印梯度 d(out)/dx

std::cout << x.grad() << std::endl;

输出

 4.5000  4.5000
 4.5000  4.5000
[ CPUFloatType{2,2} ]

您应该得到一个 4.5 的矩阵。有关我们如何得出此值的解释，请参阅此教程中相应的章节。

现在让我们来看一个向量-雅可比乘积的例子

x = torch::randn(3, torch::requires_grad());

y = x * 2;
while (y.norm().item<double>() < 1000) {
  y = y * 2;
}

std::cout << y << std::endl;
std::cout << y.grad_fn()->name() << std::endl;

输出

-1021.4020
  314.6695
 -613.4944
[ CPUFloatType{3} ]
MulBackward1

如果我们想要向量-雅可比乘积，请将向量作为参数传递给 backward

auto v = torch::tensor({0.1, 1.0, 0.0001}, torch::kFloat);
y.backward(v);

std::cout << x.grad() << std::endl;

输出

4000
0000
1024
[ CPUFloatType{3} ]

您可以通过在代码块中放置 torch::NoGradGuard 来阻止 autograd 跟踪需要梯度的张量历史记录

std::cout << x.requires_grad() << std::endl;
std::cout << x.pow(2).requires_grad() << std::endl;

{
  torch::NoGradGuard no_grad;
  std::cout << x.pow(2).requires_grad() << std::endl;
}

输出

true
true
false

或者使用 .detach() 获取具有相同内容但不需要梯度的张量

std::cout << x.requires_grad() << std::endl;
y = x.detach();
std::cout << y.requires_grad() << std::endl;
std::cout << x.eq(y).all().item<bool>() << std::endl;

输出

true
false
true

有关 C++ 张量 autograd API（例如 grad / requires_grad / is_leaf / backward / detach / detach_ / register_hook / retain_grad）的更多信息，请参阅相应的 C++ API 文档。

在 C++ 中计算高阶梯度#

高阶梯度的应用之一是计算梯度惩罚。让我们通过 torch::autograd::grad 来看一个例子

#include <torch/torch.h>

auto model = torch::nn::Linear(4, 3);

auto input = torch::randn({3, 4}).requires_grad_(true);
auto output = model(input);

// Calculate loss
auto target = torch::randn({3, 3});
auto loss = torch::nn::MSELoss()(output, target);

// Use norm of gradients as penalty
auto grad_output = torch::ones_like(output);
auto gradient = torch::autograd::grad({output}, {input}, /*grad_outputs=*/{grad_output}, /*create_graph=*/true)[0];
auto gradient_penalty = torch::pow((gradient.norm(2, /*dim=*/1) - 1), 2).mean();

// Add gradient penalty to loss
auto combined_loss = loss + gradient_penalty;
combined_loss.backward();

std::cout << input.grad() << std::endl;

输出

-0.1042 -0.0638  0.0103  0.0723
-0.2543 -0.1222  0.0071  0.0814
-0.1683 -0.1052  0.0355  0.1024
[ CPUFloatType{3,4} ]

有关如何使用 torch::autograd::backward (链接) 和 torch::autograd::grad (链接) 的更多信息，请参阅文档。

在 C++ 中使用自定义 autograd 函数#

(改编自此教程)

向 torch::autograd 添加新的基本操作需要为每个操作实现一个新的 torch::autograd::Function 子类。 torch::autograd::Function 是 torch::autograd 用来计算结果和梯度，并编码操作历史的对象。每个新函数都需要您实现 2 个方法：forward 和 backward，有关详细要求，请参阅此链接。

下面是 torch::nn 中 Linear 函数的代码

#include <torch/torch.h>

using namespace torch::autograd;

// Inherit from Function
class LinearFunction : public Function<LinearFunction> {
 public:
  // Note that both forward and backward are static functions

  // bias is an optional argument
  static torch::Tensor forward(
      AutogradContext *ctx, torch::Tensor input, torch::Tensor weight, torch::Tensor bias = torch::Tensor()) {
    ctx->save_for_backward({input, weight, bias});
    auto output = input.mm(weight.t());
    if (bias.defined()) {
      output += bias.unsqueeze(0).expand_as(output);
    }
    return output;
  }

  static tensor_list backward(AutogradContext *ctx, tensor_list grad_outputs) {
    auto saved = ctx->get_saved_variables();
    auto input = saved[0];
    auto weight = saved[1];
    auto bias = saved[2];

    auto grad_output = grad_outputs[0];
    auto grad_input = grad_output.mm(weight);
    auto grad_weight = grad_output.t().mm(input);
    auto grad_bias = torch::Tensor();
    if (bias.defined()) {
      grad_bias = grad_output.sum(0);
    }

    return {grad_input, grad_weight, grad_bias};
  }
};

然后，我们可以通过以下方式使用 LinearFunction

auto x = torch::randn({2, 3}).requires_grad_();
auto weight = torch::randn({4, 3}).requires_grad_();
auto y = LinearFunction::apply(x, weight);
y.sum().backward();

std::cout << x.grad() << std::endl;
std::cout << weight.grad() << std::endl;

输出

5314  1.2807  1.4864
5314  1.2807  1.4864
[ CPUFloatType{2,3} ]
7608  0.9101  0.0073
7608  0.9101  0.0073
7608  0.9101  0.0073
7608  0.9101  0.0073
[ CPUFloatType{4,3} ]

在这里，我们给出一个由非张量参数参数化的函数的附加示例

#include <torch/torch.h>

using namespace torch::autograd;

class MulConstant : public Function<MulConstant> {
 public:
  static torch::Tensor forward(AutogradContext *ctx, torch::Tensor tensor, double constant) {
    // ctx is a context object that can be used to stash information
    // for backward computation
    ctx->saved_data["constant"] = constant;
    return tensor * constant;
  }

  static tensor_list backward(AutogradContext *ctx, tensor_list grad_outputs) {
    // We return as many input gradients as there were arguments.
    // Gradients of non-tensor arguments to forward must be `torch::Tensor()`.
    return {grad_outputs[0] * ctx->saved_data["constant"].toDouble(), torch::Tensor()};
  }
};

然后，我们可以通过以下方式使用 MulConstant

auto x = torch::randn({2}).requires_grad_();
auto y = MulConstant::apply(x, 5.5);
y.sum().backward();

std::cout << x.grad() << std::endl;

输出

 5.5000
 5.5000
[ CPUFloatType{2} ]

有关 torch::autograd::Function 的更多信息，请参阅其文档。

将 autograd 代码从 Python 翻译到 C++#

从宏观上看，在 C++ 中使用 autograd 的最简单方法是先编写可用的 Python autograd 代码，然后使用下表将您的 autograd 代码从 Python 翻译到 C++

Python	C++
`torch.autograd.backward`	`torch::autograd::backward` (链接)
`torch.autograd.grad`	`torch::autograd::grad` (链接)
`torch.Tensor.detach`	`torch::Tensor::detach` (链接)
`torch.Tensor.detach_`	`torch::Tensor::detach_` (链接)
`torch.Tensor.backward`	`torch::Tensor::backward` (链接)
`torch.Tensor.register_hook`	`torch::Tensor::register_hook` (链接)
`torch.Tensor.requires_grad`	`torch::Tensor::requires_grad_` (链接)
`torch.Tensor.retain_grad`	`torch::Tensor::retain_grad` (链接)
`torch.Tensor.grad`	`torch::Tensor::grad` (链接)
`torch.Tensor.grad_fn`	`torch::Tensor::grad_fn` (链接)
`torch.Tensor.set_data`	`torch::Tensor::set_data` (链接)
`torch.Tensor.data`	`torch::Tensor::data` (链接)
`torch.Tensor.output_nr`	`torch::Tensor::output_nr` (链接)
`torch.Tensor.is_leaf`	`torch::Tensor::is_leaf` (链接)

翻译后，您的大部分 Python autograd 代码应该可以直接在 C++ 中使用。如果不是这种情况，请在 GitHub issues 上报告一个 bug，我们将尽快修复。

结论#

您现在应该对 PyTorch 的 C++ autograd API 有了很好的了解。您可以在此处找到本笔记中显示的示例代码。一如既往，如果您遇到任何问题或有疑问，可以使用我们的论坛或 GitHub issues 与我们联系。

C++ 前端中的 Autograd#

基本 autograd 操作#

在 C++ 中计算高阶梯度#

在 C++ 中使用自定义 autograd 函数#

将 autograd 代码从 Python 翻译到 C++#

结论#

文档

教程

资源