Moving the Base Test Helper (#1485)

Summary:
Pull Request resolved: #1485

moving the base test helper to the captum library. This has a lot of file dependency so apologies for the large Diff

Reviewed By: cyrjano, lurunming

Differential Revision: D68174196

fbshipit-source-id: 84f180748bd6c70cba1b7079a14e97e520228feb

tests/helpers/__init__.py → captum/testing/helpers/__init__.py

@@ -3,7 +3,7 @@
 # pyre-strict
 
 try:
-    from tests.helpers.fb.internal_base import FbBaseTest as BaseTest
+    from captum.testing.helpers.fb.internal_base import FbBaseTest as BaseTest
 
     __all__ = [
         "BaseTest",
@@ -13,4 +13,4 @@
     # tests/helpers/__init__.py:13: error: Incompatible import of "BaseTest"
     # (imported name has type "type[BaseTest]", local name has type
     # "type[FbBaseTest]")  [assignment]
-    from tests.helpers.basic import BaseTest  # type: ignore
+    from captum.testing.helpers.basic import BaseTest  # type: ignore

tests/attr/helpers/attribution_delta_util.py

@@ -4,7 +4,7 @@
 from typing import Tuple, Union
 
 import torch
-from tests.helpers import BaseTest
+from captum.testing.helpers import BaseTest
 from torch import Tensor
 
 

tests/attr/helpers/get_config_util.py

@@ -5,7 +5,7 @@
 
 import torch
 from captum._utils.gradient import compute_gradients
-from tests.helpers.basic_models import BasicModel, BasicModel5_MultiArgs
+from captum.testing.helpers.basic_models import BasicModel, BasicModel5_MultiArgs
 from torch import Tensor
 from torch.nn import Module
 

tests/attr/helpers/test_config.py

@@ -40,8 +40,8 @@
 from captum.attr._core.saliency import Saliency
 from captum.attr._core.shapley_value import ShapleyValueSampling
 from captum.attr._utils.input_layer_wrapper import ModelInputWrapper
-from tests.helpers.basic import set_all_random_seeds
-from tests.helpers.basic_models import (
+from captum.testing.helpers.basic import set_all_random_seeds
+from captum.testing.helpers.basic_models import (
     BasicModel_ConvNet,
     BasicModel_MultiLayer,
     BasicModel_MultiLayer_MultiInput,

tests/attr/layer/test_grad_cam.py

@@ -8,13 +8,13 @@
 import torch
 from captum._utils.typing import TensorLikeList
 from captum.attr._core.layer.grad_cam import LayerGradCam
-from packaging import version
-from tests.helpers import BaseTest
-from tests.helpers.basic import assertTensorTuplesAlmostEqual
-from tests.helpers.basic_models import (
+from captum.testing.helpers import BaseTest
+from captum.testing.helpers.basic import assertTensorTuplesAlmostEqual
+from captum.testing.helpers.basic_models import (
     BasicModel_ConvNet_One_Conv,
     BasicModel_MultiLayer,
 )
+from packaging import version
 from torch import Tensor
 from torch.nn import Module
 

tests/attr/layer/test_internal_influence.py

@@ -7,12 +7,12 @@
 import torch
 from captum._utils.typing import BaselineType
 from captum.attr._core.layer.internal_influence import InternalInfluence
-from packaging import version
-from tests.helpers.basic import assertTensorTuplesAlmostEqual, BaseTest
-from tests.helpers.basic_models import (
+from captum.testing.helpers.basic import assertTensorTuplesAlmostEqual, BaseTest
+from captum.testing.helpers.basic_models import (
     BasicModel_MultiLayer,
     BasicModel_MultiLayer_MultiInput,
 )
+from packaging import version
 from torch import Tensor
 from torch.nn import Module
 

tests/attr/layer/test_layer_ablation.py

@@ -8,8 +8,8 @@
 import torch
 from captum._utils.typing import BaselineType
 from captum.attr._core.layer.layer_feature_ablation import LayerFeatureAblation
-from tests.helpers.basic import assertTensorTuplesAlmostEqual, BaseTest
-from tests.helpers.basic_models import (
+from captum.testing.helpers.basic import assertTensorTuplesAlmostEqual, BaseTest
+from captum.testing.helpers.basic_models import (
     BasicModel_ConvNet_One_Conv,
     BasicModel_MultiLayer,
     BasicModel_MultiLayer_MultiInput,

tests/attr/layer/test_layer_activation.py

@@ -8,12 +8,12 @@
 import torch
 import torch.nn as nn
 from captum.attr._core.layer.layer_activation import LayerActivation
-from tests.helpers.basic import (
+from captum.testing.helpers.basic import (
     assertTensorAlmostEqual,
     assertTensorTuplesAlmostEqual,
     BaseTest,
 )
-from tests.helpers.basic_models import (
+from captum.testing.helpers.basic_models import (
     BasicModel_MultiLayer,
     BasicModel_MultiLayer_MultiInput,
     Conv1dSeqModel,

tests/attr/layer/test_layer_conductance.py

@@ -8,18 +8,18 @@
 import torch
 from captum._utils.typing import BaselineType
 from captum.attr._core.layer.layer_conductance import LayerConductance
-from packaging import version
-from tests.attr.helpers.conductance_reference import ConductanceReference
-from tests.helpers.basic import (
+from captum.testing.helpers.basic import (
     assertTensorAlmostEqual,
     assertTensorTuplesAlmostEqual,
     BaseTest,
 )
-from tests.helpers.basic_models import (
+from captum.testing.helpers.basic_models import (
     BasicModel_ConvNet,
     BasicModel_MultiLayer,
     BasicModel_MultiLayer_MultiInput,
 )
+from packaging import version
+from tests.attr.helpers.conductance_reference import ConductanceReference
 from torch import Tensor
 from torch.nn import Module
 

tests/attr/layer/test_layer_deeplift.py

@@ -9,25 +9,25 @@
 
 import torch
 from captum.attr._core.layer.layer_deep_lift import LayerDeepLift, LayerDeepLiftShap
-from packaging import version
-from tests.attr.helpers.neuron_layer_testing_util import (
-    create_inps_and_base_for_deeplift_neuron_layer_testing,
-    create_inps_and_base_for_deepliftshap_neuron_layer_testing,
-)
-from tests.helpers.basic import (
+from captum.testing.helpers.basic import (
     assert_delta,
     assertTensorAlmostEqual,
     assertTensorTuplesAlmostEqual,
     BaseTest,
 )
-from tests.helpers.basic_models import (
+from captum.testing.helpers.basic_models import (
     BasicModel_ConvNet,
     BasicModel_ConvNet_MaxPool3d,
     BasicModel_MaxPool_ReLU,
     BasicModel_MultiLayer,
     LinearMaxPoolLinearModel,
     ReLULinearModel,
 )
+from packaging import version
+from tests.attr.helpers.neuron_layer_testing_util import (
+    create_inps_and_base_for_deeplift_neuron_layer_testing,
+    create_inps_and_base_for_deepliftshap_neuron_layer_testing,
+)
 from torch import Tensor
 
 

tests/attr/layer/test_layer_feature_permutation.py

@@ -4,9 +4,9 @@
 
 import torch
 from captum.attr._core.layer.layer_feature_permutation import LayerFeaturePermutation
-from tests.helpers import BaseTest
-from tests.helpers.basic import assertTensorAlmostEqual
-from tests.helpers.basic_models import BasicModel_MultiLayer
+from captum.testing.helpers import BaseTest
+from captum.testing.helpers.basic import assertTensorAlmostEqual
+from captum.testing.helpers.basic_models import BasicModel_MultiLayer
 from torch import Tensor
 
 

tests/attr/layer/test_layer_gradient_shap.py

@@ -13,18 +13,18 @@
     LayerGradientShap,
     LayerInputBaselineXGradient,
 )
-from packaging import version
-from tests.attr.helpers.attribution_delta_util import assert_attribution_delta
-from tests.helpers.basic import (
+from captum.testing.helpers.basic import (
     assertTensorAlmostEqual,
     assertTensorTuplesAlmostEqual,
     BaseTest,
 )
-from tests.helpers.basic_models import (
+from captum.testing.helpers.basic_models import (
     BasicModel_MultiLayer,
     BasicModel_MultiLayer_MultiInput,
 )
-from tests.helpers.classification_models import SoftmaxModel
+from captum.testing.helpers.classification_models import SoftmaxModel
+from packaging import version
+from tests.attr.helpers.attribution_delta_util import assert_attribution_delta
 from torch import Tensor
 from torch.nn import Module
 

tests/attr/layer/test_layer_gradient_x_activation.py

@@ -9,13 +9,13 @@
 from captum._utils.typing import ModuleOrModuleList
 from captum.attr._core.layer.layer_activation import LayerActivation
 from captum.attr._core.layer.layer_gradient_x_activation import LayerGradientXActivation
-from packaging import version
-from tests.helpers.basic import assertTensorTuplesAlmostEqual, BaseTest
-from tests.helpers.basic_models import (
+from captum.testing.helpers.basic import assertTensorTuplesAlmostEqual, BaseTest
+from captum.testing.helpers.basic_models import (
     BasicEmbeddingModel,
     BasicModel_MultiLayer,
     BasicModel_MultiLayer_MultiInput,
 )
+from packaging import version
 from torch import Tensor
 from torch.nn import Module
 

tests/attr/layer/test_layer_integrated_gradients.py

@@ -13,17 +13,17 @@
     configure_interpretable_embedding_layer,
     remove_interpretable_embedding_layer,
 )
-from packaging import version
-from tests.helpers.basic import (
+from captum.testing.helpers.basic import (
     assertTensorAlmostEqual,
     assertTensorTuplesAlmostEqual,
     BaseTest,
 )
-from tests.helpers.basic_models import (
+from captum.testing.helpers.basic_models import (
     BasicEmbeddingModel,
     BasicModel_MultiLayer,
     BasicModel_MultiLayer_TrueMultiInput,
 )
+from packaging import version
 from torch import Tensor
 from torch.nn import Module
 

tests/attr/layer/test_layer_lrp.py

@@ -9,9 +9,12 @@
 from captum.attr import LayerLRP
 from captum.attr._utils.lrp_rules import Alpha1_Beta0_Rule, EpsilonRule, GammaRule
 
-from tests.helpers import BaseTest
-from tests.helpers.basic import assertTensorAlmostEqual
-from tests.helpers.basic_models import BasicModel_ConvNet_One_Conv, SimpleLRPModel
+from captum.testing.helpers import BaseTest
+from captum.testing.helpers.basic import assertTensorAlmostEqual
+from captum.testing.helpers.basic_models import (
+    BasicModel_ConvNet_One_Conv,
+    SimpleLRPModel,
+)
 from torch import Tensor
 
 

tests/attr/models/test_base.py

@@ -12,8 +12,8 @@
     InterpretableEmbeddingBase,
     remove_interpretable_embedding_layer,
 )
-from tests.helpers.basic import assertTensorAlmostEqual
-from tests.helpers.basic_models import BasicEmbeddingModel, TextModule
+from captum.testing.helpers.basic import assertTensorAlmostEqual
+from captum.testing.helpers.basic_models import BasicEmbeddingModel, TextModule
 from torch.nn import Embedding
 
 

tests/attr/neuron/test_neuron_ablation.py

@@ -12,9 +12,9 @@
     TensorOrTupleOfTensorsGeneric,
 )
 from captum.attr._core.neuron.neuron_feature_ablation import NeuronFeatureAblation
-from tests.helpers import BaseTest
-from tests.helpers.basic import assertTensorAlmostEqual
-from tests.helpers.basic_models import (
+from captum.testing.helpers import BaseTest
+from captum.testing.helpers.basic import assertTensorAlmostEqual
+from captum.testing.helpers.basic_models import (
     BasicModel_ConvNet_One_Conv,
     BasicModel_MultiLayer,
     BasicModel_MultiLayer_MultiInput,

tests/attr/neuron/test_neuron_conductance.py

@@ -9,15 +9,15 @@
 from captum._utils.typing import BaselineType, TensorOrTupleOfTensorsGeneric
 from captum.attr._core.layer.layer_conductance import LayerConductance
 from captum.attr._core.neuron.neuron_conductance import NeuronConductance
-
-from packaging import version
-from tests.helpers import BaseTest
-from tests.helpers.basic import assertTensorAlmostEqual
-from tests.helpers.basic_models import (
+from captum.testing.helpers import BaseTest
+from captum.testing.helpers.basic import assertTensorAlmostEqual
+from captum.testing.helpers.basic_models import (
     BasicModel_ConvNet,
     BasicModel_MultiLayer,
     BasicModel_MultiLayer_MultiInput,
 )
+
+from packaging import version
 from torch import Tensor
 from torch.nn import Module
 

tests/attr/neuron/test_neuron_deeplift.py

@@ -9,18 +9,18 @@
 import torch
 from captum._utils.typing import TensorOrTupleOfTensorsGeneric
 from captum.attr._core.neuron.neuron_deep_lift import NeuronDeepLift, NeuronDeepLiftShap
-from tests.attr.helpers.neuron_layer_testing_util import (
-    create_inps_and_base_for_deeplift_neuron_layer_testing,
-    create_inps_and_base_for_deepliftshap_neuron_layer_testing,
-)
-from tests.helpers import BaseTest
-from tests.helpers.basic import assertTensorAlmostEqual
-from tests.helpers.basic_models import (
+from captum.testing.helpers import BaseTest
+from captum.testing.helpers.basic import assertTensorAlmostEqual
+from captum.testing.helpers.basic_models import (
     BasicModel_ConvNet,
     BasicModel_ConvNet_MaxPool3d,
     LinearMaxPoolLinearModel,
     ReLULinearModel,
 )
+from tests.attr.helpers.neuron_layer_testing_util import (
+    create_inps_and_base_for_deeplift_neuron_layer_testing,
+    create_inps_and_base_for_deepliftshap_neuron_layer_testing,
+)
 from torch import Tensor
 
 

tests/attr/neuron/test_neuron_gradient.py

@@ -10,12 +10,12 @@
 from captum._utils.typing import TensorOrTupleOfTensorsGeneric
 from captum.attr._core.neuron.neuron_gradient import NeuronGradient
 from captum.attr._core.saliency import Saliency
-from tests.helpers.basic import (
+from captum.testing.helpers.basic import (
     assertTensorAlmostEqual,
     assertTensorTuplesAlmostEqual,
     BaseTest,
 )
-from tests.helpers.basic_models import (
+from captum.testing.helpers.basic_models import (
     BasicModel_ConvNet,
     BasicModel_MultiLayer,
     BasicModel_MultiLayer_MultiInput,

tests/attr/neuron/test_neuron_gradient_shap.py

@@ -8,10 +8,10 @@
 from captum.attr._core.neuron.neuron_integrated_gradients import (
     NeuronIntegratedGradients,
 )
-from tests.helpers import BaseTest
-from tests.helpers.basic import assertTensorAlmostEqual
-from tests.helpers.basic_models import BasicModel_MultiLayer
-from tests.helpers.classification_models import SoftmaxModel
+from captum.testing.helpers import BaseTest
+from captum.testing.helpers.basic import assertTensorAlmostEqual
+from captum.testing.helpers.basic_models import BasicModel_MultiLayer
+from captum.testing.helpers.classification_models import SoftmaxModel
 from torch import Tensor
 from torch.nn import Module
 

tests/attr/neuron/test_neuron_integrated_gradients.py

@@ -11,12 +11,12 @@
 from captum.attr._core.neuron.neuron_integrated_gradients import (
     NeuronIntegratedGradients,
 )
-from tests.helpers.basic import (
+from captum.testing.helpers.basic import (
     assertTensorAlmostEqual,
     assertTensorTuplesAlmostEqual,
     BaseTest,
 )
-from tests.helpers.basic_models import (
+from captum.testing.helpers.basic_models import (
     BasicModel_ConvNet,
     BasicModel_MultiLayer,
     BasicModel_MultiLayer_MultiInput,

tests/attr/test_approximation_methods.py

@@ -7,7 +7,7 @@
 
 import torch
 from captum.attr._utils.approximation_methods import Riemann, riemann_builders
-from tests.helpers.basic import assertTensorAlmostEqual
+from captum.testing.helpers.basic import assertTensorAlmostEqual
 
 
 class Test(unittest.TestCase):

tests/attr/test_baselines.py

@@ -4,7 +4,7 @@
 from captum.attr._utils.baselines import ProductBaselines
 
 # from parameterized import parameterized
-from tests.helpers import BaseTest
+from captum.testing.helpers import BaseTest
 
 
 class TestProductBaselines(BaseTest):

tests/attr/test_class_summarizer.py

@@ -5,7 +5,7 @@
 
 import torch
 from captum.attr import ClassSummarizer, CommonStats
-from tests.helpers import BaseTest
+from captum.testing.helpers import BaseTest
 
 
 class Test(BaseTest):