自定義合成

---
Loader:
  data:
    filepath: 'benchmark://adult-income'
Preprocessor:
  demo:
    method: 'default'
Synthesizer:
  custom:
    method: 'custom_method'
    module_path: 'custom-synthesis.py'  # 自定義合成器的路徑
    class_name: 'MySynthesizer_Shuffle' # 合成器類別名稱
Postprocessor:
  demo:
    method: 'default'
Evaluator:
  demo:
    method: 'default'
Reporter:
  save_report_global:
    method: 'save_report'
    granularity: 'global'
...

import numpy as np
import pandas as pd

from petsard.loader import Metadata


class MySynthesizer_Shuffle:
    """
    一個簡單的合成器，獨立地隨機排列每個欄位。

    這個合成器保留每個欄位的分佈，同時打破欄位之間的關係。
    這對於簡單的匿名化或作為基準合成資料生成方法很有用。
    """

    def __init__(self, config: dict, metadata: Metadata):
        """
        初始化合成器。

        在這個示範中我們不使用 metadata，但請保留它在簽名中，
        並且歡迎準備您的合成器使用它。

        Args:
            metadata (Metadata): 元數據物件。
        """
        self.config: dict = config
        self.result: pd.DataFrame = None

        if "random_seed" in self.config:
            np.random.seed(self.config["random_seed"])

    def fit(self, data: pd.DataFrame) -> None:
        """
        隨機排列演算法
        """
        if not isinstance(data, pd.DataFrame):
            raise TypeError("資料必須是 pandas DataFrame")

        if data.empty:
            raise ValueError("無法訓練空資料")

        columns: list[str] = data.columns.tolist()
        synthetic_data: pd.DataFrame = pd.DataFrame()

        values: np.ndarray = None
        for col in columns:
            # 獲取欄位數據並適當處理不同類型
            original_series: pd.Series = data[col]

            if pd.api.types.is_categorical_dtype(original_series):
                # 對於分類數據，轉換為代碼，隨機排列，然後映射回來
                codes = original_series.cat.codes.values.copy()
                np.random.shuffle(codes)
                # 將隨機排列的代碼轉換回分類值
                synthetic_data[col] = pd.Categorical.from_codes(
                    codes,
                    categories=original_series.cat.categories,
                    ordered=original_series.cat.ordered,
                )
            else:
                # 對於非分類數據，創建值的副本並隨機排列
                values = original_series.values.copy()
                np.random.shuffle(values)
                synthetic_data[col] = values

        self.result = synthetic_data

    def sample(self) -> pd.DataFrame:
        return self.result