Improved Metrics System (#40)

* Start implementing metrics tests * Starting a notebook on validating the metrics * [WIP] Start generalizing the fourier nRMSE to allow for derivative based losses * Set up a new structure for metrics * New export structure * Overwrite the existing metrics submodule * Adapt tests because domain_extent is now considered correctly * Test against analytical solution * Fix parameterization of test * Start set up with a new fourier metrics implementation * Ensure correct shape * Add first test on Fourier aggregation * Add basic abolute metrics, more TODO * Port the correlation metric * New API in docs * Port new spatial metrics to API docs * Rework correlation documentation * Add drafts on an advanced background notebook on metrics and their relation to functional norms * Fix the scaling in the Fourier aggregation * Use pytest approx * Fix scaling * Add equivalence test of Fourier and spatial aggregation * Rework implementations * Remove mean correlation * Add soboleb based metrics * Add helper function to apply metric functions on batched states * Test with non-unit domain * Start with a low-level introduction to metrics * Add basics notebook * Adapt API docs * Add to API docs * Add documentation to spatial metrics * Reference does not be zero in normalized metrics * Add documentation * Fix documentation * Test Sobolev against manual adding of derivatives with fourier-base metrics * Fix typo * Add documentation * Add tests on Filtering * Add notes on preliminary notebook * Fix broken links * Also add warning to advanced metrics notebook * Continue with the metric convergence notebook, still WIP * Add example on Sobolev usage * Finish validation notebook
Ceyron · Sep 23, 2024 · 86a2c97 · 86a2c97
1 parent a17af96
commit 86a2c97
Show file tree

Hide file tree

Showing 21 changed files with 2,806 additions and 671 deletions.
diff --git a/docs/api/utilities/metrics/correlation.md b/docs/api/utilities/metrics/correlation.md
@@ -1,11 +1,3 @@
 # Correlation
 
 ::: exponax.metrics.correlation
-
----
-
-::: exponax.metrics.mean_correlation
-
----
-
-::: exponax.metrics._correlation
diff --git a/docs/api/utilities/metrics/derivative.md b/docs/api/utilities/metrics/derivative.md
@@ -0,0 +1,25 @@
+# Derivative-based Metrics
+
+Related to Sobolev Norms
+
+::: exponax.metrics.H1_MSE
+
+---
+
+::: exponax.metrics.H1_MAE
+
+---
+
+::: exponax.metrics.H1_RMSE
+
+---
+
+::: exponax.metrics.H1_nMSE
+
+---
+
+::: exponax.metrics.H1_nMAE
+
+---
+
+::: exponax.metrics.H1_nRMSE
diff --git a/docs/api/utilities/metrics/fourier.md b/docs/api/utilities/metrics/fourier.md
@@ -0,0 +1,31 @@
+# Fourier-based
+
+::: exponax.metrics.fourier_MSE
+
+---
+
+::: exponax.metrics.fourier_MAE
+
+---
+
+::: exponax.metrics.fourier_RMSE
+
+---
+
+::: exponax.metrics.fourier_nMSE
+
+---
+
+::: exponax.metrics.fourier_nMAE
+
+---
+
+::: exponax.metrics.fourier_nRMSE
+
+---
+
+::: exponax.metrics.fourier_norm
+
+---
+
+::: exponax.metrics.fourier_aggregator
diff --git a/docs/api/utilities/metrics/fourier_nrmse.md b/docs/api/utilities/metrics/fourier_nrmse.md
diff --git a/docs/api/utilities/metrics/mse_based.md b/docs/api/utilities/metrics/mse_based.md
diff --git a/docs/api/utilities/metrics/rmse_based.md b/docs/api/utilities/metrics/rmse_based.md
diff --git a/docs/api/utilities/metrics/spatial.md b/docs/api/utilities/metrics/spatial.md
@@ -0,0 +1,31 @@
+# Spatial-based
+
+::: exponax.metrics.MSE
+
+---
+
+::: exponax.metrics.MAE
+
+---
+
+::: exponax.metrics.RMSE
+
+---
+
+::: exponax.metrics.nMSE
+
+---
+
+::: exponax.metrics.nMAE
+
+---
+
+::: exponax.metrics.nRMSE
+
+---
+
+::: exponax.metrics.spatial_norm
+
+---
+
+::: exponax.metrics.spatial_aggregator
diff --git a/docs/api/utilities/metrics/utils.md b/docs/api/utilities/metrics/utils.md
@@ -0,0 +1,3 @@
+# Utilities for Metric Computation
+
+::: exponax.metrics.mean_metric
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Utilities for Metric Computation

		::: exponax.metrics.mean_metric