Class AdequacyReport
- All Implemented Interfaces:
TetradSerializable, Serializable
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionfinal doubleRepresents the fractionfinal doubleRepresents the mean improvement of nodes over a baseline metric in the context of an adequacy report.final doubleRepresents the global Maximum Mean Discrepancy squared (MMD²) value between the real and simulated data distributions in the context of an adequacy report.final List<NodeAdequacySummary> Represents a collection of adequacy summaries for individual nodes within a model. -
Method Summary
Modifier and TypeMethodDescriptiondoubleRetrieves the fraction of nodes that demonstrated performance improvement relative to the baseline.doubleRetrieves the mean improvement of nodes over a baseline metric.doublegetMmd2()Retrieves the squared Maximum Mean Discrepancy (MMD²) value, which quantifies the alignment between real and simulated data distributions.toText()Converts the adequacy report data into a human-readable textual representation.
-
Field Details
-
meanImprovement
public final double meanImprovementRepresents the mean improvement of nodes over a baseline metric in the context of an adequacy report.This value indicates the average magnitude of improvement across all nodes, providing a summary measure for assessing overall performance enhancement.
-
fracNodesImproved
public final double fracNodesImprovedRepresents the fraction -
mmd2
public final double mmd2Represents the global Maximum Mean Discrepancy squared (MMD²) value between the real and simulated data distributions in the context of an adequacy report.This metric provides a quantitative measure of how well the simulated data aligns with the real data, with smaller values indicating closer alignment. It is useful in evaluating the overall representational quality of the simulation process.
-
nodeSummaries
Represents a collection of adequacy summaries for individual nodes within a model.Each element in this list provides detailed metrics and performance insights for a specific node, including its name, parents, and performance improvements relative to a baseline. This field is used as part of the adequacy report to evaluate the performance and improvements of nodes in the context of the overall model.
This list is immutable and provides a comprehensive snapshot of per-node evaluation results.
-
-
Method Details
-
toText
Converts the adequacy report data into a human-readable textual representation.The resulting text includes global metrics, such as mean improvement over the baseline, the fraction of nodes that showed improvement, and the global MMD^2 value. It also provides a per-node breakdown of holdout improvements, listing each node along with its specific improvement value.
- Returns:
- A string representation of the adequacy report, including global and per-node metrics formatted for readability.
-
getMmd2
public double getMmd2()Retrieves the squared Maximum Mean Discrepancy (MMD²) value, which quantifies the alignment between real and simulated data distributions.- Returns:
- The global MMD² value as a double, representing the measure of distributional similarity.
-
getMeanImprovement
public double getMeanImprovement()Retrieves the mean improvement of nodes over a baseline metric.- Returns:
- The mean improvement value as a double, indicating the average improvement across nodes.
-
getFracImproved
public double getFracImproved()Retrieves the fraction of nodes that demonstrated performance improvement relative to the baseline.- Returns:
- The fraction of nodes improved as a double, representing the proportion of nodes with performance enhancement.
-