Skip to content

Commit 25558f5

Browse files
authored
docs: updated API docs for DCR (#168)
1 parent df6fec7 commit 25558f5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

mostlyai/qa/metrics.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ class Distances(CustomBaseModel):
169169
an optimal sensitivity of this privacy assessment it is recommended to use a 50/50 split between training and
170170
holdout data, and then generate synthetic data of the same size.
171171
172-
The embeddings of these samples are then computed, and the L2 nearest neighbor distances are calculated for each
172+
The embeddings of these samples are then computed, and the nearest neighbor distances are calculated for each
173173
synthetic sample to the training and holdout samples. Based on these nearest neighbor distances the following
174174
metrics are calculated:
175175
- Identical Match Share (IMS): The share of synthetic samples that are identical to a training or holdout sample.
@@ -205,19 +205,19 @@ class Distances(CustomBaseModel):
205205
dcr_training: float | None = Field(
206206
default=None,
207207
alias="dcrTraining",
208-
description="Average L2 nearest-neighbor distance between synthetic and training samples.",
208+
description="Average nearest-neighbor distance between synthetic and training samples.",
209209
ge=0.0,
210210
)
211211
dcr_holdout: float | None = Field(
212212
default=None,
213213
alias="dcrHoldout",
214-
description="Average L2 nearest-neighbor distance between synthetic and holdout samples. Serves as a reference for `dcr_training`.",
214+
description="Average nearest-neighbor distance between synthetic and holdout samples. Serves as a reference for `dcr_training`.",
215215
ge=0.0,
216216
)
217217
dcr_trn_hol: float | None = Field(
218218
default=None,
219219
alias="dcrTrnHol",
220-
description="Average L2 nearest-neighbor distance between training and holdout samples. Serves as a reference for `dcr_training`.",
220+
description="Average nearest-neighbor distance between training and holdout samples. Serves as a reference for `dcr_training`.",
221221
ge=0.0,
222222
)
223223
dcr_share: float | None = Field(

0 commit comments

Comments
 (0)