PyTorch torch.is_grad_enabled 関数


Pytorch torch リファレンスマニュアル

torch.is_grad_enabledPyTorch で、現在勾配計算が有効かどうかを確認するための関数です。現在の PyTorch の勾配計算機能が有効か無効かを示すブール値を返します。

これは、勾配の状態に応じて異なるロジックを実行する必要があるコードを記述する際に非常に役立ちます。

関数定義

torch.is_grad_enabled()

パラメータ:

  • パラメータなし。

戻り値:

  • ブール値を返します。現在勾配計算が有効な場合は、True;そうでない場合はFalse。

使用例

例 1: 基本的な使い方

実例

import torch

# デフォルトでは、勾配計算は有効です
print(デフォルト状態:, torch.is_grad_enabled())

# no_grad コンテキスト内
with torch.no_grad():
    print(no_grad 内:, torch.is_grad_enabled())

# 終了後は復元される
print(no_grad 終了後:, torch.is_grad_enabled())

出力結果:

默认状态: True
在 no_grad 中: False
退出 no_grad 后: True

例 2: set_grad_enabled との組み合わせ

実例

import torch

# 現在の状態を確認
print(現在の状態:, torch.is_grad_enabled())

# 勾配を無効化
torch.set_grad_enabled(False)
print(無効化後:, torch.is_grad_enabled())

# 勾配を有効化
torch.set_grad_enabled(True)
print(有効化後:, torch.is_grad_enabled())

出力結果:

当前状态: True
禁用后: False
启用后: True

例 3: 条件分岐での使用

実例

import torch

def process_tensor(x):
    """勾配状態に応じてテンソルを処理"""
    if torch.is_grad_enabled():
        print(勾配計算を有効化)
        # 逆伝播が可能
        y = x * 2
        return y
    else:
        print(勾配計算を無効化)
        # メモリを節約した高速計算
        y = x * 2
        return y

# 異なる状態をテスト
x = torch.tensor([1.0, 2.0, 3.0])

print(=== 勾配有効 ===)
result1 = process_tensor(x)

print(n=== 勾配無効 ===)
with torch.no_grad():
    result2 = process_tensor(x)

出力結果:

=== 勾配を有効にする ===
勾配計算を有効にする

=== 勾配を無効にする ===
勾配計算を無効にする

例 4: カスタムレイヤーでの使用

実例

import torch
import torch.nn as nn

class CustomLayer(nn.Module):
    def __init__(self):
        super().__init__()
        self.weight = nn.Parameter(torch.randn(10, 10))

    def forward(self, x):
        # 勾配状態を確認して異なる処理を行う
        if torch.is_grad_enabled():
            print(トレーニングモード)
            # トレーニング時は通常どおり計算
            return torch.mm(x, self.weight)
        else:
            print(推論モード)
            # 推論時は最適化バージョンを使用可能
            with torch.no_grad():
                return torch.mm(x, self.weight)

layer = CustomLayer()
x = torch.randn(5, 10)

# トレーニング
layer.train()
output1 = layer(x)

# 推論
layer.eval()
with torch.no_grad():
    output2 = layer(x)

出力結果:

トレーニングモード
推論モード

関連関数

  • torch.no_grad(): 勾配計算を無効化するコンテキストマネージャー。
  • torch.enable_grad(): 勾配計算を有効化するコンテキストマネージャー。
  • torch.set_grad_enabled(grad): 勾配計算を有効にするかどうかを設定します。

注意事項

  • is_grad_enabled読み取り専用の関数であり、状態を変更することはありません。
  • チェックするのはグローバルな勾配計算状態であり、個々のテンソルのrequires_grad属性ではありません。
  • 汎用コードを書くとき、この関数を使用して現在の状態に応じて異なる最適化戦略を実行できます。

Pytorch torch リファレンスマニュアル

その他の拡張