Rework plots return displayable objects, and allow caching as HTML/SVG (

epic-open-source#28)
diehlbw · Jun 25, 2024 · d50567a · d50567a
1 parent 1af5a64
commit d50567a
Show file tree

Hide file tree

Showing 21 changed files with 1,056 additions and 496 deletions.
diff --git a/.gitignore b/.gitignore
@@ -96,4 +96,6 @@ scripted_testing/
 /notebooks/data/
 example-notebooks/binary-classifier/dictionary.yml
 example-notebooks/binary-classifier/data/*
-example-notebooks/binary-classifier/outputs/*
+example-notebooks/binary-classifier/outputs/*
+
+.seismometer_cache/
diff --git a/changelog/43.feature..rst b/changelog/43.feature..rst
@@ -0,0 +1,2 @@
+* Updated plots to use HTML and SVG over pngs from matplotlib
+* Added DiskCachedFunction to allow disk caching of HTML content
diff --git a/docs/reference/internals.rst b/docs/reference/internals.rst
@@ -112,14 +112,22 @@ Summaries
    summaries.default_cohort_summaries
    summaries.score_target_cohort_summaries
 
-.. currentmodule:: seismometer.core.patterns
 
 Low-level patterns
 ------------------
 
 Patterns
 ~~~~~~~~
+.. currentmodule:: seismometer.core.patterns
 .. autosummary::
    :toctree: api/
 
    Singleton
+
+Decorators
+~~~~~~~~~~
+.. currentmodule:: seismometer.core.decorators
+.. autosummary::
+   :toctree: api/
+
+   DiskCachedFunction
diff --git a/docs/reference/seismometer.rst b/docs/reference/seismometer.rst
@@ -20,7 +20,6 @@ Public API
    plot_cohort_hist
    plot_leadtime_enc
    plot_trend_intervention_outcome
-   plot_ts_cohort
    show_info
    show_cohort_summaries
    target_feature_summary