Contents Menu Expand Light mode Dark mode Auto light/dark mode
Clover documentation
Clover documentation

Getting Started

  • What is Clover?
  • Installation
  • Quickstart
  • Getting Involved
  • MIT License

User Guide

  • Introduction
  • Generators
    • DataSynthesizer
    • Synthpop
    • SMOTE
    • Private-PGM - MST
    • Conditional Tabular GAN (CTGAN)
    • TVAE
    • FinDiff
  • Metrics
    • Utility Metrics
    • Privacy Metrics
  • Optimization
    • Discrete Particle Swarm Optimization
    • Hyperparameter tuning with Optuna
    • Parallel hyperparameter tuning with RayTune

API

  • Generators API
    • generators
  • Metrics API
    • metrics
      • metrics.utility
      • metrics.privacy
  • Optimization API
    • optimization
  • Utilities API
    • utils

Tutorial

  • Synthetic Data Generation
  • How to generate a utility report?
  • How to generate a membership inference attacks report?
  • Synthetic Data Generation – Find the best hyperparameters
  • How to generate a combined utility/privacy report?
  • How to generate a metareport?
Back to top

Optimization API#

Optimization classes and functions available in the library. Please refer to the Optimization section in the User Guide for further details, as the raw specifications may not provide a comprehensive overview.

  • optimization
    • optimization.base
    • optimization.discrete_pso_search
    • optimization.optuna_search
    • optimization.raytune_search
    • optimization.objective_function
Next
optimization
Previous
metrics.privacy
Copyright © 2023, IVADO PRF3 Human Health
Made with Sphinx and @pradyunsg's Furo