From 7e576164963021130c2841168c0660b86a7f12cd Mon Sep 17 00:00:00 2001 From: voetberg Date: Fri, 21 Jun 2024 15:52:20 -0500 Subject: [PATCH] Prettied up the metrics and plots docs pages --- src/deepdiagnostics/metrics/all_sbc.py | 16 +++++++------- .../metrics/coverage_fraction.py | 16 +++++++------- .../metrics/local_two_sample.py | 18 +++++++-------- src/deepdiagnostics/plots/cdf_ranks.py | 20 ++++++++--------- .../plots/coverage_fraction.py | 21 +++++++++--------- src/deepdiagnostics/plots/local_two_sample.py | 21 +++++++++--------- .../plots/predictive_posterior_check.py | 22 +++++++++---------- src/deepdiagnostics/plots/ranks.py | 22 +++++++++---------- src/deepdiagnostics/plots/tarp.py | 21 +++++++++--------- 9 files changed, 87 insertions(+), 90 deletions(-) diff --git a/src/deepdiagnostics/metrics/all_sbc.py b/src/deepdiagnostics/metrics/all_sbc.py index 28a6dba..775291f 100644 --- a/src/deepdiagnostics/metrics/all_sbc.py +++ b/src/deepdiagnostics/metrics/all_sbc.py @@ -20,14 +20,14 @@ class AllSBC(Metric): """ def __init__( self, - model: Any, - data: Any, - out_dir: str | None = None, - save: bool=True, - use_progress_bar: Optional[bool] = None, - samples_per_inference: Optional[int] = None, - percentiles: Optional[Sequence[int]] = None, - number_simulations: Optional[int] = None, + model, + data, + out_dir= None, + save = True, + use_progress_bar = None, + samples_per_inference = None, + percentiles = None, + number_simulations = None, ) -> None: super().__init__(model, data, out_dir, diff --git a/src/deepdiagnostics/metrics/coverage_fraction.py b/src/deepdiagnostics/metrics/coverage_fraction.py index 04e4933..4d660c9 100644 --- a/src/deepdiagnostics/metrics/coverage_fraction.py +++ b/src/deepdiagnostics/metrics/coverage_fraction.py @@ -18,14 +18,14 @@ class CoverageFraction(Metric): def __init__( self, - model: Any, - data: Any, - out_dir: Optional[str] = None, - save: bool=True, - use_progress_bar: Optional[bool] = None, - samples_per_inference: Optional[int] = None, - percentiles: Optional[Sequence[int]] = None, - number_simulations: Optional[int] = None, + model, + data, + out_dir= None, + save=True, + use_progress_bar = None, + samples_per_inference = None, + percentiles = None, + number_simulations = None, ) -> None: super().__init__(model, data, out_dir, diff --git a/src/deepdiagnostics/metrics/local_two_sample.py b/src/deepdiagnostics/metrics/local_two_sample.py index 978b977..c6e7e50 100644 --- a/src/deepdiagnostics/metrics/local_two_sample.py +++ b/src/deepdiagnostics/metrics/local_two_sample.py @@ -1,4 +1,4 @@ -from typing import Any, Optional, Sequence, Union +from typing import Any, Union import numpy as np @@ -26,14 +26,14 @@ class LocalTwoSampleTest(Metric): """ def __init__( self, - model: Any, - data: Any, - out_dir: Optional[str] = None, - save: bool=True, - use_progress_bar: Optional[bool] = None, - samples_per_inference: Optional[int] = None, - percentiles: Optional[Sequence[int]] = None, - number_simulations: Optional[int] = None, + model, + data, + out_dir = None, + save=True, + use_progress_bar = None, + samples_per_inference = None, + percentiles = None, + number_simulations = None, ) -> None: super().__init__( diff --git a/src/deepdiagnostics/plots/cdf_ranks.py b/src/deepdiagnostics/plots/cdf_ranks.py index ac4b2e7..1c581e1 100644 --- a/src/deepdiagnostics/plots/cdf_ranks.py +++ b/src/deepdiagnostics/plots/cdf_ranks.py @@ -10,16 +10,16 @@ def __init__( self, model, data, - save:bool, - show:bool, - out_dir:Optional[str]=None, - percentiles: Optional[Sequence] = None, - use_progress_bar: Optional[bool] = None, - samples_per_inference: Optional[int] = None, - number_simulations: Optional[int] = None, - parameter_names: Optional[Sequence] = None, - parameter_colors: Optional[Sequence]= None, - colorway: Optional[str]=None): + save, + show, + out_dir=None, + percentiles = None, + use_progress_bar= None, + samples_per_inference = None, + number_simulations= None, + parameter_names = None, + parameter_colors = None, + colorway =None): """ Adaptation of :cite:p:`centero2020sbi`. diff --git a/src/deepdiagnostics/plots/coverage_fraction.py b/src/deepdiagnostics/plots/coverage_fraction.py index 42beead..acfb61c 100644 --- a/src/deepdiagnostics/plots/coverage_fraction.py +++ b/src/deepdiagnostics/plots/coverage_fraction.py @@ -26,17 +26,16 @@ def __init__( self, model, data, - save:bool, - show:bool, - out_dir:Optional[str]=None, - percentiles: Optional[Sequence] = None, - use_progress_bar: Optional[bool] = None, - samples_per_inference: Optional[int] = None, - number_simulations: Optional[int] = None, - parameter_names: Optional[Sequence] = None, - parameter_colors: Optional[Sequence]= None, - colorway: Optional[str]=None - ): + save, + show, + out_dir=None, + percentiles = None, + use_progress_bar= None, + samples_per_inference = None, + number_simulations= None, + parameter_names = None, + parameter_colors = None, + colorway =None): super().__init__(model, data, save, show, out_dir, percentiles, use_progress_bar, samples_per_inference, number_simulations, parameter_names, parameter_colors, colorway) diff --git a/src/deepdiagnostics/plots/local_two_sample.py b/src/deepdiagnostics/plots/local_two_sample.py index 4814979..3efbcba 100644 --- a/src/deepdiagnostics/plots/local_two_sample.py +++ b/src/deepdiagnostics/plots/local_two_sample.py @@ -41,17 +41,16 @@ def __init__( self, model, data, - save:bool, - show:bool, - out_dir:Optional[str]=None, - percentiles: Optional[Sequence] = None, - use_progress_bar: Optional[bool] = None, - samples_per_inference: Optional[int] = None, - number_simulations: Optional[int] = None, - parameter_names: Optional[Sequence] = None, - parameter_colors: Optional[Sequence]= None, - colorway: Optional[str]=None - ): + save, + show, + out_dir=None, + percentiles = None, + use_progress_bar= None, + samples_per_inference = None, + number_simulations= None, + parameter_names = None, + parameter_colors = None, + colorway =None): super().__init__(model, data, save, show, out_dir, percentiles, use_progress_bar, samples_per_inference, number_simulations, parameter_names, parameter_colors, colorway) self.region_colors = get_hex_colors(n_colors=len(self.percentiles), colorway=self.colorway) diff --git a/src/deepdiagnostics/plots/predictive_posterior_check.py b/src/deepdiagnostics/plots/predictive_posterior_check.py index b56a798..b884e2f 100644 --- a/src/deepdiagnostics/plots/predictive_posterior_check.py +++ b/src/deepdiagnostics/plots/predictive_posterior_check.py @@ -22,17 +22,17 @@ def __init__( self, model, data, - save:bool, - show:bool, - out_dir:Optional[str]=None, - percentiles: Optional[Sequence] = None, - use_progress_bar: Optional[bool] = None, - samples_per_inference: Optional[int] = None, - number_simulations: Optional[int] = None, - parameter_names: Optional[Sequence] = None, - parameter_colors: Optional[Sequence]= None, - colorway: Optional[str]=None - ): + save, + show, + out_dir=None, + percentiles = None, + use_progress_bar= None, + samples_per_inference = None, + number_simulations= None, + parameter_names = None, + parameter_colors = None, + colorway =None): + super().__init__(model, data, save, show, out_dir, percentiles, use_progress_bar, samples_per_inference, number_simulations, parameter_names, parameter_colors, colorway) def plot_name(self): diff --git a/src/deepdiagnostics/plots/ranks.py b/src/deepdiagnostics/plots/ranks.py index 746cf71..af2bf0d 100644 --- a/src/deepdiagnostics/plots/ranks.py +++ b/src/deepdiagnostics/plots/ranks.py @@ -24,17 +24,17 @@ def __init__( self, model, data, - save:bool, - show:bool, - out_dir:Optional[str]=None, - percentiles: Optional[Sequence] = None, - use_progress_bar: Optional[bool] = None, - samples_per_inference: Optional[int] = None, - number_simulations: Optional[int] = None, - parameter_names: Optional[Sequence] = None, - parameter_colors: Optional[Sequence]= None, - colorway: Optional[str]=None - ): + save, + show, + out_dir=None, + percentiles = None, + use_progress_bar= None, + samples_per_inference = None, + number_simulations= None, + parameter_names = None, + parameter_colors = None, + colorway =None): + super().__init__(model, data, save, show, out_dir, percentiles, use_progress_bar, samples_per_inference, number_simulations, parameter_names, parameter_colors, colorway) def plot_name(self): diff --git a/src/deepdiagnostics/plots/tarp.py b/src/deepdiagnostics/plots/tarp.py index ba39fd6..95a1f86 100644 --- a/src/deepdiagnostics/plots/tarp.py +++ b/src/deepdiagnostics/plots/tarp.py @@ -29,17 +29,16 @@ def __init__( self, model, data, - save:bool, - show:bool, - out_dir:Optional[str]=None, - percentiles: Optional[Sequence] = None, - use_progress_bar: Optional[bool] = None, - samples_per_inference: Optional[int] = None, - number_simulations: Optional[int] = None, - parameter_names: Optional[Sequence] = None, - parameter_colors: Optional[Sequence]= None, - colorway: Optional[str]=None - ): + save, + show, + out_dir=None, + percentiles = None, + use_progress_bar= None, + samples_per_inference = None, + number_simulations= None, + parameter_names = None, + parameter_colors = None, + colorway =None): super().__init__(model, data, save, show, out_dir, percentiles, use_progress_bar, samples_per_inference, number_simulations, parameter_names, parameter_colors, colorway) self.line_style = get_item(