docs(notebooks): add README for encrypted fairness-metrics notebook - #2624
Merged
Ilya Matiach (imatiach-msft) merged 2 commits intoApr 29, 2026
Merged
Conversation
Companion README for the fairness-dashboard-encrypted-metrics.ipynb notebook merged in microsoft#2623. Documents the fairlearn-fhe drop-in API, trust models (Mode A/B), audit envelope + CLI verification, CKKS parameter knobs, raiwidgets handoff, and per-metric circuit depths.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a companion README for the encrypted fairness-metrics notebook (fairness-dashboard-encrypted-metrics.ipynb) to explain the fairlearn → fairlearn_fhe swap, trust models, audit-envelope flow, and CKKS parameterization for fairlearn-fhe.
Changes:
- Add
README-fairlearn-fhe.mddocumenting the notebook’s purpose, workflow, trust models, and audit-envelope verification flow. - Document CKKS context defaults/overrides and provide expected sample output and runtime notes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…learn-fhe.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Ilya Matiach (imatiach-msft)
approved these changes
Apr 29, 2026
Collaborator
|
this looks great, let me just wait for all tests to run and then I will merge |
Collaborator
|
it seems like you need to run prettier on the readme, but I can just fix that in another PR: |
Ilya Matiach (imatiach-msft)
merged commit Apr 29, 2026
94379f6
into
microsoft:main
35 of 58 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a companion README for the
fairness-dashboard-encrypted-metrics.ipynbnotebook that landed in #2623.The README documents:
fairlearn↔fairlearn_fheimport swaptrust_modelenvelope field strings (plaintext_sensitive_features/encrypted_sensitive_features)audit_metric→MetricEnvelope→ JSON Schema →sign_envelopePython API →fairlearn-fhe verifyCLI with--max-age/--min-security-bits/--max-depth/--public-key)raiwidgets.FairnessDashboardfor the analyst-facing viewbuild_contextreal signature, defaults atpoly_modulus_degree=16384,scale_bits=40, depth-6 chain, 128-bit security target) and how to override>=3.10, <3.13, fairlearn>=0.10, etc.), and per-metric circuit depths (DP=3, equalized-odds/equal-opportunity=6) read fromobserved_depthin the envelope