check_sparse_tensor_invariants

class torch.sparse.check_sparse_tensor_invariants(enable=True)

用于控制检查稀疏张量不变量的工具。

以下选项用于在稀疏张量构造中管理稀疏张量不变量检查

1. 使用上下文管理器

   with torch.sparse.check_sparse_tensor_invariants():
       run_my_model()
   

2. 使用过程方法

   prev_checks_enabled = torch.sparse.check_sparse_tensor_invariants.is_enabled()
   torch.sparse.check_sparse_tensor_invariants.enable()
   
   run_my_model()
   
   if not prev_checks_enabled:
       torch.sparse.check_sparse_tensor_invariants.disable()
   

3. 使用函数装饰器

   @torch.sparse.check_sparse_tensor_invariants()
   def run_my_model():
       ...
   
   run_my_model()
   

4. 在稀疏张量构造函数调用中使用 check_invariants 关键字参数。例如

   >>> torch.sparse_csr_tensor([0, 1, 3], [0, 1], [1, 2], check_invariants=True)
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
   RuntimeError: `crow_indices[..., -1] == nnz` is not satisfied.
   

static disable()

在稀疏张量构造函数中禁用稀疏张量不变量检查。

有关更多信息，请参阅 torch.sparse.check_sparse_tensor_invariants.enable()。

static enable()

在稀疏张量构造函数中启用稀疏张量不变量检查。

注意

默认情况下，稀疏张量不变量检查处于禁用状态。使用 torch.sparse.check_sparse_tensor_invariants.is_enabled() 获取稀疏张量不变量检查的当前状态。

注意

稀疏张量不变量检查标志对所有稀疏张量构造函数都有效，包括 Python 和 ATen 中的构造函数。

可以通过稀疏张量构造函数的 check_invariants 可选参数在本地覆盖此标志。

static is_enabled()

如果启用了稀疏张量不变量检查，则返回 True。

注意

使用 torch.sparse.check_sparse_tensor_invariants.enable() 或 torch.sparse.check_sparse_tensor_invariants.disable() 管理稀疏张量不变量检查的状态。