refactor: rename transformers and validators for clarity

jordandeklerk · jordandeklerk · commit 726c56323d7e · 2025-11-07T13:48:44.000-05:00
diff --git a/moderndid/core/preprocess/transformers.py b/moderndid/core/preprocess/transformers.py
@@ -151,8 +151,8 @@ def transform(self, data: pd.DataFrame, config: BasePreprocessConfig) -> pd.Data
         return data
 
 
-class NeverTreatedHandler(BaseTransformer):
-    """Never treated handler."""
+class ControlGroupCreator(BaseTransformer):
+    """Control group creator."""
 
     def transform(self, data: pd.DataFrame, config: BasePreprocessConfig) -> pd.DataFrame:
         """Transform data."""
@@ -258,8 +258,8 @@ def transform(self, data: pd.DataFrame, config: BasePreprocessConfig) -> pd.Data
         return data
 
 
-class GroupFilter(BaseTransformer):
-    """Group filter."""
+class EarlyTreatmentGroupFilter(BaseTransformer):
+    """Early treatment group filter."""
 
     def transform(self, data: pd.DataFrame, config: BasePreprocessConfig) -> pd.DataFrame:
         """Transform data."""
@@ -370,8 +370,8 @@ def update(data: pd.DataFrame, config: BasePreprocessConfig) -> None:
             config.cband = False
 
 
-class TwoPeriodColumnSelector(BaseTransformer):
-    """Two-period column selector."""
+class PrePostColumnSelector(BaseTransformer):
+    """Pre-post column selector."""
 
     def transform(self, data: pd.DataFrame, config: BasePreprocessConfig | TwoPeriodDIDConfig) -> pd.DataFrame:
         """Transform data."""
@@ -397,8 +397,8 @@ def transform(self, data: pd.DataFrame, config: BasePreprocessConfig | TwoPeriod
         return data[cols_to_keep].copy()
 
 
-class TwoPeriodCovariateProcessor(BaseTransformer):
-    """Two-period covariate processor."""
+class PrePostCovariateProcessor(BaseTransformer):
+    """Pre-post covariate processor."""
 
     def transform(self, data: pd.DataFrame, config: BasePreprocessConfig | TwoPeriodDIDConfig) -> pd.DataFrame:
         """Transform data."""
@@ -432,8 +432,8 @@ def transform(self, data: pd.DataFrame, config: BasePreprocessConfig | TwoPeriod
         return data_processed
 
 
-class TwoPeriodPanelBalancer(BaseTransformer):
-    """Two-period panel balancer."""
+class PrePostPanelBalancer(BaseTransformer):
+    """Pre-post panel balancer."""
 
     def transform(self, data: pd.DataFrame, config: BasePreprocessConfig | TwoPeriodDIDConfig) -> pd.DataFrame:
         """Transform data."""
@@ -450,8 +450,8 @@ def transform(self, data: pd.DataFrame, config: BasePreprocessConfig | TwoPeriod
         return data[data[config.idname].isin(ids_to_keep)].copy()
 
 
-class TwoPeriodTimeInvarianceChecker(BaseTransformer):
-    """Two-period time invariance checker."""
+class PrePostInvarianceChecker(BaseTransformer):
+    """Pre-post invariance checker."""
 
     def transform(self, data: pd.DataFrame, config: BasePreprocessConfig | TwoPeriodDIDConfig) -> pd.DataFrame:
         """Transform data."""
@@ -498,7 +498,7 @@ def get_did_pipeline() -> "DataTransformerPipeline":
                 WeightNormalizer(),
                 TreatmentEncoder(),
                 EarlyTreatmentFilter(),
-                NeverTreatedHandler(),
+                ControlGroupCreator(),
                 PanelBalancer(),
                 RepeatedCrossSectionHandler(),
                 DataSorter(),
@@ -514,7 +514,7 @@ def get_cont_did_pipeline() -> "DataTransformerPipeline":
                 MissingDataHandler(),
                 WeightNormalizer(),
                 TimePeriodRecoder(),
-                GroupFilter(),
+                EarlyTreatmentGroupFilter(),
                 DoseValidator(),
                 PanelBalancer(),
                 DataSorter(),
@@ -526,12 +526,12 @@ def get_two_period_pipeline() -> "DataTransformerPipeline":
         """Get two-period pipeline."""
         return DataTransformerPipeline(
             [
-                TwoPeriodColumnSelector(),
+                PrePostColumnSelector(),
                 MissingDataHandler(),
-                TwoPeriodCovariateProcessor(),
+                PrePostCovariateProcessor(),
                 WeightNormalizer(),
-                TwoPeriodPanelBalancer(),
-                TwoPeriodTimeInvarianceChecker(),
+                PrePostPanelBalancer(),
+                PrePostInvarianceChecker(),
             ]
         )
 
diff --git a/moderndid/core/preprocess/validators.py b/moderndid/core/preprocess/validators.py
@@ -264,8 +264,8 @@ def _create_result(errors: list[str] | None = None, warnings: list[str] | None =
         return ValidationResult(is_valid=len(errors) == 0, errors=errors, warnings=warnings)
 
 
-class TwoPeriodColumnValidator(BaseValidator):
-    """Two-period column validator."""
+class PrePostColumnValidator(BaseValidator):
+    """Pre-post column validator."""
 
     def validate(self, data: pd.DataFrame, config: BasePreprocessConfig | TwoPeriodDIDConfig) -> ValidationResult:
         """Validate data."""
@@ -313,8 +313,8 @@ def _create_result(errors: list[str] | None = None, warnings: list[str] | None =
         return ValidationResult(is_valid=len(errors) == 0, errors=errors, warnings=warnings)
 
 
-class TwoPeriodValidator(BaseValidator):
-    """Two-period validator."""
+class PrePostDataValidator(BaseValidator):
+    """Pre-post data validator."""
 
     def validate(self, data: pd.DataFrame, config: BasePreprocessConfig | TwoPeriodDIDConfig) -> ValidationResult:
         """Validate data."""
@@ -342,8 +342,8 @@ def _create_result(errors: list[str] | None = None, warnings: list[str] | None =
         return ValidationResult(is_valid=len(errors) == 0, errors=errors, warnings=warnings)
 
 
-class TwoPeriodPanelValidator(BaseValidator):
-    """Two-period panel validator."""
+class PrePostPanelValidator(BaseValidator):
+    """Pre-post panel validator."""
 
     def validate(self, data: pd.DataFrame, config: BasePreprocessConfig | TwoPeriodDIDConfig) -> ValidationResult:
         """Validate data."""
@@ -386,9 +386,9 @@ def _get_default_validators(config_type: str = "did") -> list[BaseValidator]:
         """Get default validators."""
         if config_type == "two_period":
             return [
-                TwoPeriodColumnValidator(),
-                TwoPeriodValidator(),
-                TwoPeriodPanelValidator(),
+                PrePostColumnValidator(),
+                PrePostDataValidator(),
+                PrePostPanelValidator(),
             ]
 
         common_validators = [
