Follow-up to #12, which covered audit_equivalence.
What's Needed
Nine functions still have no Examples section:
audit_frequency, audit_missing, audit_stationarityaudit_point_anomalies, audit_contextual_anomaliesaudit_correlation_leakage, audit_temporal_leakage, audit_asof_leakageaudit_validity, audit_combination_leakageaudit_panel_structure, audit_cross_sectional_leakage
One or two per PR is fine. See the Examples section in
tsauditor/leakage/equivalence.py for the format and level of detail.
Please run the example before submitting. Paste the real output, not what you
expect it to be. Every example in the wiki was executed against the installed
package before being committed, and the same standard applies here.
Note we do not run doctests in CI yet (see #NN), so an incorrect example will not
fail the build. It has to be checked by hand.
Follow-up to #12, which covered
audit_equivalence.What's NeededNine functions still have no
Examplessection:audit_frequency,audit_missing,audit_stationarityaudit_point_anomalies,audit_contextual_anomaliesaudit_correlation_leakage,audit_temporal_leakage,audit_asof_leakageaudit_validity,audit_combination_leakageaudit_panel_structure,audit_cross_sectional_leakageOne or two per PR is fine. See the
Examplessection intsauditor/leakage/equivalence.pyfor the format and level of detail.Please run the example before submitting. Paste the real output, not what you
expect it to be. Every example in the wiki was executed against the installed
package before being committed, and the same standard applies here.
Note we do not run doctests in CI yet (see #NN), so an incorrect example will not
fail the build. It has to be checked by hand.