nvflare.app_common.psi.recipes.dh_psi module

Recipe helpers for DH-based Private Set Intersection (PSI).

class DhPSIRecipe(*, name: str = 'dh_psi', min_clients: int, local_psi: PSI, output_path: str = 'psi/intersection.txt')[source]

Bases: Recipe

Job recipe for running DH-PSI.

This is a job composition helper (server workflow + client executors/components).

Constructor of DhPSIRecipe.

Parameters:

  • name – Name of the federated job.

  • min_clients – Minimum number of clients required to start the PSI workflow.

  • local_psi – PSI component implementation used on each client to compute local PSI artifacts.

  • output_path – Local file path on each client where the PSI intersection result will be written.