Skip to content

moda-gov-tw/PETsARD

Repository files navigation

Python 3.10 Python 3.11 Contributions welcome PyPI - Status

PETsARD (Privacy Enhancing Technologies Analysis, Research, and Development, /pəˈtɑrd/) is a Python library for facilitating synthetic data generation and evaluation processes.

PETsARD(隱私強化技術分析、研究與開發)是一套為了促進合成資料生成與評估過程而設計的 Python 程式庫。


✨ Features 主要功能

  • 🔄 Data Generation 資料生成: Multiple synthetic data generation algorithms 多種合成資料生成演算法
  • 🔒 Privacy Evaluation 隱私評估: Comprehensive privacy risk assessment 全面的隱私風險評估
  • 📊 Utility Metrics 效用指標: Data quality and utility measurements 資料品質與效用測量
  • 🎯 Flexible Configuration 靈活配置: YAML-based workflow configuration 基於 YAML 的工作流程配置
  • 📦 Benchmark Datasets 基準資料集: Built-in benchmark dataset support 內建基準資料集支援

📚 Documentation 文件

Website 網站: https://nics-dp.github.io/petsard/

  • PyPI installation PyPI 安裝
  • Docker deployment Docker 部署
  • Offline setup 離線設置
  • Default synthesis workflow 預設合成流程
  • Using external synthetic data 使用外部合成資料
  • Experiment design 實驗設計
  • Fidelity vs. utility 保真度與效用
  • Privacy risk estimation 隱私風險估計
  • Long-tail distribution handling 長尾分佈處理
  • Time anchoring 時間錨定
  • Uniform encoding 統一編碼
  • Executor, Loader, Splitter 執行器、載入器、分割器
  • Preprocessor, Synthesizer, Postprocessor 前處理器、合成器、後處理器
  • Evaluator, Constrainer, Reporter 評估器、約束器、報告器
  • Data types and logical types 資料型別與邏輯型別
  • Attribute parameters 屬性參數
  • Statistics configuration 統計配置
  • Programmatic usage API 參考 API reference
  • Development setup 開發環境設置
  • Test coverage 測試覆蓋率
  • Key terminology 關鍵術語
  • Common errors and solutions 常見錯誤與解決方案

🛠️ Development 開發

Requirements 需求

  • Python 3.10 or 3.11 Python 3.10 或 3.11

Quick Start 快速開始

# Install 安裝
pip install petsard

# Run tests 執行測試
pip install petsard[dev]
pytest

📄 License 授權

This project is licensed under MIT License. See LICENSE for details.

本專案採用 MIT License 授權。詳見 LICENSE


🔗 Links 連結


📧 Contact 聯絡

For questions or support: 如有問題或需要支援:

  • Open an issue on GitHub 在 GitHub 開啟 issue
  • Check the documentation 查看文件

Contributors 6

Languages