文件
PETsARD YAML
Reporter YAML

Reporter YAML

Reporter 模組負責輸出實驗結果，支援資料儲存、評估報告和時間記錄等多種報告格式。

使用範例

請點擊下方按鈕在 Colab 中執行範例：

Open In Colab

Loader:
  load_data:
    filepath: benchmark://adult-income
    schema: benchmark://adult-income_schema
Synthesizer:
  synthesize:
    method: default
Evaluator:
  fidelity_check:
    method: sdmetrics-qualityreport

Reporter:
  save_synthetic:
    method: save_data
    source: Synthesizer

  save_report:
    method: save_report
    granularity: global

  save_schema:
    method: save_schema
    source:
      - Loader
      - Synthesizer

  save_timing:
    method: save_timing

支援的報告方法

本模組支援以下報告輸出方式，每種方法的詳細參數請參考各子頁面：

  1. 儲存資料 - 將合成資料或其他模組的輸出儲存為 CSV 檔案
  2. 產生評估報告 - 產生評估結果報告，支援多種粒度層級
  3. 儲存表詮釋資料 - 輸出指定模組的資料欄位 schema 資訊
  4. 儲存驗證結果 - 將 Constrainer 驗證結果輸出為結構化 CSV 報告
  5. 儲存時間資訊 - 記錄各模組的執行時間

命名策略與實驗名稱

PETsARD 採用統一的實驗命名規範，用於識別和追蹤實驗過程。

命名策略概述

Reporter 模組支援兩種命名策略，可透過 naming_strategy 參數控制：

  1. TRADITIONAL：維持向後相容性的傳統命名格式
  2. COMPACT：提供更簡潔易讀的命名格式

實驗名稱格式

實驗元組

full_expt_tuple 是一個由模組名稱和實驗名稱組成的元組：

(module_name, experiment_name)

此格式主要用於 Reporter 系統識別和組織實驗結果。

實驗字串

full_expt_name 是將模組名稱和實驗名稱用連字號串接的字串：

{module_name}-{experiment_name}

檔案命名格式

save_data 方法

策略格式範例
Traditional{output}_{module}[{experiment}].csvpetsard_Synthesizer[exp1].csv
Compact{output}_{module}_{experiment}.csvpetsard_Synthesizer_exp1.csv

save_report 方法

策略格式範例
Traditional{output}_Reporter[{eval}_[{granularity}]].csvpetsard_Reporter[eval1_[global]].csv
Compact{output}_{eval}_{granularity}.csvpetsard_eval1_global.csv

save_timing 方法

所有策略使用相同格式：

{output}_timing_report.csv

模組簡寫對照表（Compact 策略）

模組名稱簡寫範例檔名
LoaderLdpetsard_Ld.load_adult.csv
SplitterSppetsard_Sp.train_test.csv
ProcessorPrpetsard_Pr.normalize.csv
SynthesizerSypetsard_Sy.ctgan_baseline.csv
ConstrainerCnpetsard_Cn.privacy_check.csv
EvaluatorEvpetsard_Ev.utility_eval.csv
ReporterRppetsard_Rp.summary.csv

粒度簡寫對照表（Compact 策略）

粒度名稱簡寫範例檔名
globalGpetsard_eval_privacy.G.csv
columnwiseCpetsard_eval_column.C.csv
pairwisePpetsard_eval_correlation.P.csv
detailsDpetsard_eval_detailed.D.csv
treeTpetsard_eval_hierarchical.T.csv

命名建議

  1. 模組名稱

    • 使用標準模組名稱：‘Synthesizer’、‘Evaluator’、‘Processor’ 等
    • 注意大小寫需要完全匹配

  2. 實驗名稱

    • 使用有意義的前綴：’exp’、’eval’、’test’ 等
    • 用底線分隔不同部分：方法名稱、參數設定等
    • 評估層級使用方括號：[global]、[columnwise]、[pairwise]

  3. 參數編碼

    • 參數名稱使用縮寫：method、batch、epoch 等
    • 數值使用簡潔表示：300、0.1 等
    • 多參數用底線連接：method_a_batch500

  4. 策略選擇

    • 新專案：建議使用 compact 策略，檔名更簡潔
    • 現有專案：使用 traditional 策略以保持相容性
    • 檔案管理：compact 策略的檔名更易於排序和分類

通用參數

所有報告方法都支援以下通用參數：

  • output (string, 選用) - 輸出檔案名稱前綴，預設為 petsard
  • naming_strategy (string, 選用) - 檔名命名策略，可選 traditional（預設）或 compact

注意事項

  • Reporter 應在所有需要報告的模組執行完畢後執行
  • 同名檔案會被覆寫，建議使用不同的 output 前綴
  • 所有報告都以 CSV 格式儲存，使用 UTF-8 編碼
  • 建議新專案使用 compact 命名策略，現有專案保持 traditional 以確保相容性