C++ 前端中的 Autograd
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
如果我们想要向量-Jacobian 乘积,请将向量作为参数传递给backward
:
auto v = torch::tensor({0.1, 1.0, 0.0001}, torch::kFloat);
y.backward(v);
std::cout << x.grad() << std::endl;
出:
102.4000
1024.0000
0.1024
[ CPUFloatType{3} ]
您也可以通过在代码块中放置torch::NoGradGuard
来停止对需要梯度的张量的跟踪历史的自动定格
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++ 张量自动梯度 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
计算结果和梯度,并对操作历史进行编码。 每个新函数都需要您实现两种方法: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;
出:
0.5314 1.2807 1.4864
0.5314 1.2807 1.4864
[ CPUFloatType{2,3} ]
3.7608 0.9101 0.0073
3.7608 0.9101 0.0073
3.7608 0.9101 0.0073
3.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 ISSUE 中提交错误报告,我们将尽快对其进行修复。
总结
现在,您应该对 PyTorch 的 C++ autograd API 有了一个很好的了解。 您可以在此处找到本说明中显示的代码示例。 与往常一样,如果您遇到任何问题或疑问,可以使用我们的论坛或 GitHub ISSUE 进行联系。