PyTorch / clamp関数とclamp_関数の違いについて

Question

#質問
「PyTorchによる物体検出」（新納浩幸）を読み進めています。SSDネットワーク構築の途中、dbox実装でclamp_という関数を使っている場所があり、初見であった為調べてみたところ、clampとclamp_の二つがあるそうなのですが、その違いについて結論に至らなかったので質問させていただきます。

#やってみたこと
試しに、1×8のテンソルにmin=3, max=6を引数に指定してそれぞれの関数を適用してみました。

import torch

x = torch.arange(8)

y1 = x.clamp(min = 3, max = 6)
y2 = x.clamp_(min = 3, max = 6)

print('y1 =', y1)
print('y2 =', y2)

出力：

y1 = tensor([3, 3, 3, 3, 4, 5, 6, 6])
y2 = tensor([3, 3, 3, 3, 4, 5, 6, 6])

すると、以上の様に、他のいくつかの例で試しても、両者は一致するのではないかと予想しました。が、やはり_の有無が結果にどう影響するかが気になります。どなたかお力添え頂ける箇所が御座いましたら、ご教授のほど何卒よろしくお願い申し上げます。

Answer 1

_ が末尾についているのは、inplace (コピーを作らず元の配列を直接変更する) で処理を行う関数です。
処理を行うときにコピーが発生しないので、元の配列の値を取っておく必要がない場合はこちらのほうが高速です。

import torch

x = torch.arange(8)
y1 = x.clamp(min = 3, max = 6)
print(x)  # 元の配列 x は変更されず、コピーに対して処理を行い返す
# tensor([0, 1, 2, 3, 4, 5, 6, 7])

y2 = x.clamp_(min = 3, max = 6)
print(x) # 元の配列 x が変更され、その参照が返される
# tensor([3, 3, 3, 3, 4, 5, 6, 6])

Comments

[kay_ventris4]

そういうことでしたか！ご丁寧にありがとう御座いました。