@@ -15,16 +15,30 @@ set of columns, wrap it in a :class:`Metric` with a column selector, e.g.
1515``Metric(fn, selector=cs.all()) ``, ``Metric(fn, selector=cs.boolean()) ``, or
1616``Metric(fn, selector=cs.by_name("my_column_name")) ``.
1717
18+ Presets come in two families, each with its own module and default set:
19+
20+ - :mod: `diffly.metrics.change ` describes the *change * between numeric columns by
21+ aggregating over ``right - left ``.
22+ - :mod: `diffly.metrics.data ` describes the left and right datasets *individually *,
23+ so you can see how a change affects the data.
24+
25+ The two default sets are combined into :data: `DEFAULT_METRICS `.
26+
1827.. autodata :: MetricFn
1928 :no-value:
2029
2130.. autoclass :: Metric
2231
32+ .. autodata :: DEFAULT_METRICS
33+ :no-value:
34+
2335Change metrics
2436==============
2537
38+ .. currentmodule :: diffly.metrics.change
39+
2640Metrics that describe the change between numeric columns by aggregating over
27- ``right - left ``. They live in :mod: ` diffly.metrics.change `.
41+ ``right - left ``.
2842
2943.. autosummary ::
3044 :toctree: _gen/
@@ -38,14 +52,21 @@ Metrics that describe the change between numeric columns by aggregating over
3852 mean_relative_deviation
3953 quantile
4054
55+ .. autodata :: DEFAULT_CHANGE_METRICS
56+ :no-value:
57+
4158Data metrics
4259============
4360
61+ .. currentmodule :: diffly.metrics.data
62+
4463Metrics that describe the left and right datasets individually, so you can
45- understand how a change affects the data. They live in
46- :mod: `diffly.metrics.data `.
64+ understand how a change affects the data.
4765
4866.. autosummary ::
4967 :toctree: _gen/
5068
5169 null_fraction_change
70+
71+ .. autodata :: DEFAULT_DATA_METRICS
72+ :no-value:
0 commit comments