spacekit 1.1.3__tar.gz → 1.1.5__tar.gz

{spacekit-1.1.3 → spacekit-1.1.5}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Ru Keïn
+Copyright (c) 2026 Ru Keïn
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{spacekit-1.1.3/spacekit.egg-info → spacekit-1.1.5}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: spacekit
-Version: 1.1.3
+Version: 1.1.5
 Summary: Astronomical Data Science and Machine Learning Toolkit
 Home-page: https://github.com/spacetelescope/spacekit
 Author: Ru Keïn
 Author-email: rkein@stsci.edu
 License: MIT
 Project-URL: Source, https://github.com/spacetelescope/spacekit
-Project-URL: Documentation, https://spacekit.readthedocs.io
+Project-URL: Documentation, https://www.spacekit.org
 Project-URL: Tracker, https://github.com/spacetelescope/spacekit/issues
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering :: Astronomy
@@ -17,13 +17,14 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: tensorflow>=2.16.1
 Requires-Dist: astropy
 Requires-Dist: boto3
-Requires-Dist: numpy>=1.22
+Requires-Dist: numpy>=1.25
 Requires-Dist: pandas
 Requires-Dist: scikit-learn>=1.3.2
 Provides-Extra: test
@@ -109,7 +110,7 @@ $ pytest --env jwstcal -m jwst
 
 **JWST Calibration Pipeline Resource Prediction (JWST)**
 
-[JWST CAL Docs](https://spacekit.readthedocs.io/en/latest/skopes/jwst/cal.html)
+[JWST CAL Docs](https://www.spacekit.org/en/latest/skopes/jwst/cal/index.html)
 
 * Inference ``spacekit.skopes.jwst.cal.predict``
 
@@ -143,7 +144,7 @@ $ python -m spacekit.skopes.jwst.cal.predict /path/to/inputs --pid 1076
 
 **Single Visit Mosaic Alignment (HST)**
 
-[SVM Docs](https://spacekit.readthedocs.io/en/latest/skopes/hst/svm.html)
+[SVM Docs](https://www.spacekit.org/en/latest/skopes/hst/svm/index.html)
 
 * Preprocessing: ``spacekit.skopes.hst.svm.prep``
 * Predict Image Alignments: ``spacekit.skopes.hst.svm.predict``
@@ -154,7 +155,7 @@ $ python -m spacekit.skopes.jwst.cal.predict /path/to/inputs --pid 1076
 
 **HST Calibration Pipeline Resource Prediction (HST)**
 
-[HST CAL Docs](https://spacekit.readthedocs.io/en/latest/skopes/hst/cal.html)
+[HST CAL Docs](https://www.spacekit.org/en/latest/skopes/hst/cal/index.html)
 
 * Training ``spacekit.skopes.hst.cal.train``
 * Inference ``spacekit.skopes.hst.cal.predict``
@@ -162,7 +163,7 @@ $ python -m spacekit.skopes.jwst.cal.predict /path/to/inputs --pid 1076
 
 **Exoplanet Detection with time-series photometry (K2, TESS)**
 
-[K2 Docs](https://spacekit.readthedocs.io/en/latest/skopes/kepler/light-curves.html)
+[K2 Docs](https://www.spacekit.org/en/latest/skopes/kepler/light_curves.html)
 
 * ``spacekit.skopes.kepler.light_curves``
 
@@ -184,7 +185,7 @@ ens.batch_fit()
 
 # Save Training Metrics
 outputs = f"data/{date_timestamp}"
-com = ComputeBinary(builder=ens, res_path=f"{outputs}/results/test")
+com = ComputeBinary(builder=ens, res_path=f"{outputs}/results/test", classes=["aligned", "misaligned"])
 com.calculate_results()
 ```
 # Load and plot metrics to evaluate and compare model performance

{spacekit-1.1.3 → spacekit-1.1.5}/README.md

@@ -52,7 +52,7 @@ $ pytest --env jwstcal -m jwst
 
 **JWST Calibration Pipeline Resource Prediction (JWST)**
 
-[JWST CAL Docs](https://spacekit.readthedocs.io/en/latest/skopes/jwst/cal.html)
+[JWST CAL Docs](https://www.spacekit.org/en/latest/skopes/jwst/cal/index.html)
 
 * Inference ``spacekit.skopes.jwst.cal.predict``
 
@@ -86,7 +86,7 @@ $ python -m spacekit.skopes.jwst.cal.predict /path/to/inputs --pid 1076
 
 **Single Visit Mosaic Alignment (HST)**
 
-[SVM Docs](https://spacekit.readthedocs.io/en/latest/skopes/hst/svm.html)
+[SVM Docs](https://www.spacekit.org/en/latest/skopes/hst/svm/index.html)
 
 * Preprocessing: ``spacekit.skopes.hst.svm.prep``
 * Predict Image Alignments: ``spacekit.skopes.hst.svm.predict``
@@ -97,7 +97,7 @@ $ python -m spacekit.skopes.jwst.cal.predict /path/to/inputs --pid 1076
 
 **HST Calibration Pipeline Resource Prediction (HST)**
 
-[HST CAL Docs](https://spacekit.readthedocs.io/en/latest/skopes/hst/cal.html)
+[HST CAL Docs](https://www.spacekit.org/en/latest/skopes/hst/cal/index.html)
 
 * Training ``spacekit.skopes.hst.cal.train``
 * Inference ``spacekit.skopes.hst.cal.predict``
@@ -105,7 +105,7 @@ $ python -m spacekit.skopes.jwst.cal.predict /path/to/inputs --pid 1076
 
 **Exoplanet Detection with time-series photometry (K2, TESS)**
 
-[K2 Docs](https://spacekit.readthedocs.io/en/latest/skopes/kepler/light-curves.html)
+[K2 Docs](https://www.spacekit.org/en/latest/skopes/kepler/light_curves.html)
 
 * ``spacekit.skopes.kepler.light_curves``
 
@@ -127,7 +127,7 @@ ens.batch_fit()
 
 # Save Training Metrics
 outputs = f"data/{date_timestamp}"
-com = ComputeBinary(builder=ens, res_path=f"{outputs}/results/test")
+com = ComputeBinary(builder=ens, res_path=f"{outputs}/results/test", classes=["aligned", "misaligned"])
 com.calculate_results()
 ```
 # Load and plot metrics to evaluate and compare model performance

{spacekit-1.1.3 → spacekit-1.1.5}/pyproject.toml

@@ -21,6 +21,7 @@ exclude = [
 [tool.ruff.lint]
 ignore = [
     'E741', # ambiguous variable name
+    'UP017', # Use `datetime.UTC` alias
 ]
 
 [tool.ruff.lint.per-file-ignores]

{spacekit-1.1.3 → spacekit-1.1.5}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = spacekit
-version = 1.1.3
+version = 1.1.5
 author = Ru Keïn
 author_email = rkein@stsci.edu
 license = MIT
@@ -13,7 +13,7 @@ edit_on_github = False
 github_project = spacetelescope/spacekit
 project_urls = 
 	Source = https://github.com/spacetelescope/spacekit
-	Documentation = https://spacekit.readthedocs.io
+	Documentation = https://www.spacekit.org
 	Tracker = https://github.com/spacetelescope/spacekit/issues
 classifiers = 
 	Intended Audience :: Science/Research
@@ -24,6 +24,7 @@ classifiers =
 	Programming Language :: Python :: 3.10
 	Programming Language :: Python :: 3.11
 	Programming Language :: Python :: 3.12
+	Programming Language :: Python :: 3.13
 
 [options]
 zip_safe = False
@@ -36,7 +37,7 @@ install_requires =
 	tensorflow>=2.16.1
 	astropy
 	boto3
-	numpy>=1.22
+	numpy>=1.25
 	pandas
 	scikit-learn>=1.3.2
 

{spacekit-1.1.3 → spacekit-1.1.5}/spacekit/analyzer/compute.py

@@ -1,26 +1,29 @@
-import os
+import datetime as dt
 import glob
 import itertools
+import os
+
 import numpy as np
 import pandas as pd
-import datetime as dt
 from sklearn.metrics import (
     auc,
-    roc_curve,
-    roc_auc_score,
-    precision_recall_curve,
     average_precision_score,
     classification_report,
     confusion_matrix,
+    precision_recall_curve,
+    roc_auc_score,
+    roc_curve,
 )
 from tensorflow.python.ops.numpy_ops import np_config
+
+from spacekit.extractor.load import load_multitype_data, save_multitype_data
 from spacekit.logger.log import Logger
-from spacekit.extractor.load import save_multitype_data, load_multitype_data
 
 try:
-    import plotly.graph_objects as go
     import matplotlib as mpl
     import matplotlib.pyplot as plt
+    import plotly.graph_objects as go
+
     font_dict = {"family": "monospace", "size": 16}  # Titillium Web
     mpl.rc("font", **font_dict)
     styles = ["seaborn-bright", "seaborn-v0_8-bright"]
@@ -40,7 +43,7 @@ def check_viz_imports():
     return go is not None
 
 
-class Computer(object):
+class Computer:
     def __init__(
         self,
         algorithm,
@@ -149,7 +152,7 @@ class Computer(object):
                     self.y_test = builder.y_val
                     self.X_train = builder.X_test
                     self.y_train = builder.y_test
-                except Exception as e:
+                except AttributeError as e:
                     print(e)
                     print("Validation attributes not set.")
             else:
@@ -174,8 +177,8 @@ class Computer(object):
             Outputs created by their respective subclasses using the ``make_outputs`` method.
         """
         if self.res_path is None:
-            timestamp = int(dt.datetime.now().timestamp())
-            datestamp = dt.date.fromtimestamp(timestamp).isoformat()
+            timestamp = int(dt.datetime.now(tz=dt.timezone.utc).timestamp())
+            datestamp = dt.datetime.fromtimestamp(timestamp, tz=dt.timezone.utc).date().isoformat()
             prefix = str(datestamp) + "-" + str(timestamp)
             self.res_path = os.path.join(os.getcwd(), prefix, "results", self.algorithm)
         save_multitype_data(
@@ -201,7 +204,7 @@ class Computer(object):
         if self.res_path is None:
             try:
                 self.res_path = glob.glob(f"data/*/results/{self.algorithm}")[0]
-            except Exception as e:
+            except IndexError as e:
                 self.log.error(f"No results found @ {self.res_path} \n", e)
                 return outputs
         if os.path.exists(self.res_path):
@@ -238,9 +241,7 @@ class Computer(object):
         """
         self.y_scores = self.model.predict(self.X_test)
         if self.y_scores.shape[1] < 2:
-            self.y_scores = np.concatenate(
-                [np.round(1 - self.y_scores), np.round(self.y_scores)], axis=1
-            )
+            self.y_scores = np.concatenate([np.round(1 - self.y_scores), np.round(self.y_scores)], axis=1)
         return self.y_scores
 
     def acc_loss_scores(self):
@@ -281,7 +282,6 @@ class Computer(object):
         self.roc_fig = self.make_roc_curve()
         self.pr_fig = self.make_pr_curve()
         self.cm_fig, self.cmx_norm = self.fusion_matrix(self.cmx, self.classes)
-        return self
 
     # Matplotlib "static" alternative to interactive plotly version
     def roc_plots(self):
@@ -312,17 +312,11 @@ class Computer(object):
         ax = axes[0]
         ax.plot(thresholds, 1.0 - fpr)
         ax.plot(thresholds, tpr)
-        ax.set_title(
-            "Crossover at {0:.2f}, Specificity {1:.2f}".format(
-                crossover_cutoff, crossover_specificity
-            )
-        )
+        ax.set_title(f"Crossover at {crossover_cutoff:.2f}, Specificity {crossover_specificity:.2f}")
 
         ax = axes[1]
         ax.plot(fpr, tpr)
-        ax.set_title(
-            "ROC area under curve: {0:.2f}".format(roc_auc_score(y_true, y_hat))
-        )
+        ax.set_title(f"ROC area under curve: {roc_auc_score(y_true, y_hat):.2f}")
         if self.show:
             fig.show()
 
@@ -337,7 +331,7 @@ class Computer(object):
             ROC-AUC interactive figure plot
         """
         fig = go.Figure()
-        fig.add_shape(type="line", line=dict(dash="dash"), x0=0, x1=1, y0=0, y1=1)
+        fig.add_shape(type="line", line={"dash":"dash"}, x0=0, x1=1, y0=0, y1=1)
 
         if regression is True:
             if self.y_pred_dummies is None:
@@ -361,8 +355,8 @@ class Computer(object):
             title_text=title,
             xaxis_title="False Positive Rate",
             yaxis_title="True Positive Rate",
-            yaxis=dict(scaleanchor="x", scaleratio=1),
-            xaxis=dict(constrain="domain"),
+            yaxis={"scaleanchor":"x", "scaleratio":1},
+            xaxis={"constrain":"domain"},
             width=800,
             height=500,
             paper_bgcolor="#242a44",
@@ -374,8 +368,27 @@ class Computer(object):
         return fig
 
     @staticmethod
-    def get_bin_estimate(y_val, n_classes=4, thresholds=[0, 12, 225, 950]):
+    def get_bin_estimate(y_val, n_classes=4, thresholds=None):
+        """_summary_
+
+        Parameters
+        ----------
+        y_val : int
+            predicted value
+        n_classes : int, optional
+            number of target classes, by default 4
+        thresholds : list, optional
+            target class threshold values (length of list much match n_classes), by default None
+
+        Returns
+        -------
+        int
+            target class bin estimate
+        """
+        thresholds = [0, 12, 225, 950] if thresholds is None else thresholds
         thresholds = sorted(thresholds, reverse=True)
+        if len(thresholds) != n_classes:
+            raise IndexError(f"n_classes = {n_classes} does not match length of thresholds list: {len(thresholds)}")
         for i in list(range(len(thresholds))):
             if y_val >= thresholds[i]:
                 return n_classes - i - 1
@@ -383,7 +396,7 @@ class Computer(object):
                 continue
 
     def make_regression_dummies(self, **kwargs):
-        y_true = [self.get_bin_estimate(t, **kwargs) for t in self.predictions[:,1]]
+        y_true = [self.get_bin_estimate(t, **kwargs) for t in self.predictions[:, 1]]
         y_scores = [self.get_bin_estimate(p, **kwargs) for p in self.predictions[:, 0]]
         y_onehot = pd.get_dummies(y_true, drop_first=False, dtype=int, prefix="bin")
         self.y_pred_dummies = pd.get_dummies(y_scores, drop_first=False, dtype=int, prefix="bin")
@@ -395,7 +408,7 @@ class Computer(object):
         self.classes = y_onehot.columns
 
     def regression_roc(self, fig):
-        fpr, tpr, self.roc_auc = dict(), dict(), dict()
+        fpr, tpr, self.roc_auc = {}, {}, {}
         for i in list(range(len(self.classes))):
             y_true = self.y_test_dummies[:, i]
             y_hat = self.y_pred_dummies.iloc[:, i]
@@ -406,7 +419,7 @@ class Computer(object):
         return fig
 
     def regression_recall(self, fig):
-        precision, recall, self.pr = dict(), dict(), dict()
+        precision, recall, self.pr = {}, {}, {}
         for i in list(range(len(self.classes))):
             y_true = self.y_test_dummies[:, i]
             y_hat = self.y_pred_dummies.iloc[:, i]
@@ -426,7 +439,7 @@ class Computer(object):
         """
 
         fig = go.Figure()
-        fig.add_shape(type="line", line=dict(dash="dash"), x0=0, x1=1, y0=1, y1=0)
+        fig.add_shape(type="line", line={"dash":"dash"}, x0=0, x1=1, y0=1, y1=0)
 
         if regression is True:
             if self.y_pred_dummies is None:
@@ -450,8 +463,8 @@ class Computer(object):
             title_text=title,
             xaxis_title="Recall",
             yaxis_title="Precision",
-            yaxis=dict(scaleanchor="x", scaleratio=1),
-            xaxis=dict(constrain="domain"),
+            yaxis={"scaleanchor":"x", "scaleratio":1},
+            xaxis={"constrain":"domain"},
             width=800,
             height=500,
             paper_bgcolor="#242a44",
@@ -479,13 +492,13 @@ class Computer(object):
                 x=n_epochs,
                 y=acc_train,
                 name=f"Training {keys[1].title()}",
-                marker=dict(color="#119dff"),
+                marker={"color":"#119dff"},
             ),
             go.Scatter(
                 x=n_epochs,
                 y=acc_test,
                 name=f"Test {keys[3].title()}",
-                marker=dict(color="#66c2a5"),
+                marker={"color":"#66c2a5"},
             ),
         ]
         layout = go.Layout(
@@ -530,13 +543,13 @@ class Computer(object):
                 x=n_epochs,
                 y=loss_train,
                 name=f"Training {keys[0].title()}",
-                marker=dict(color="#119dff"),
+                marker={"color":"#119dff"},
             ),
             go.Scatter(
                 x=n_epochs,
                 y=loss_test,
                 name=f"Test {keys[2].title()}",
-                marker=dict(color="#66c2a5"),
+                marker={"color":"#66c2a5"},
             ),
         ]
         layout = go.Layout(
@@ -560,7 +573,7 @@ class Computer(object):
         Parameters
         ----------
         desc: str, optional
-            Append custom text to title 
+            Append custom text to title
 
         Returns
         -------
@@ -574,13 +587,11 @@ class Computer(object):
             np_config.enable_numpy_behavior()
             y = self.y_test.reshape(1, -1)
             p = self.y_pred
-        
+
         title = "Residual Error"
         if desc:
             title += f" - {desc}"
-        data = go.Scatter(
-            x=y, y=p, name="y-y_hat", mode="markers", marker=dict(color="red")
-        )
+        data = go.Scatter(x=y, y=p, name="y-y_hat", mode="markers", marker={"color":"red"})
         layout = go.Layout(
             title=title,
             xaxis={"title": "y (ground truth)"},
@@ -594,7 +605,7 @@ class Computer(object):
         fig = go.Figure(data=data, layout=layout)
         fig.add_shape(
             type="line",
-            line=dict(dash="dash"),
+            line={"dash":"dash"},
             x0=y.min(),
             y0=y.min(),
             x1=y.max(),
@@ -692,14 +703,24 @@ class ComputeClassifier(Computer):
 
     Parameters
     ----------
-    Computer : Class object
-        spacekit.analyzer.compute.Computer object
+    algorithm : str, optional
+        Algorithm used for classification such as 'clf', 'binary' or 'linreg', by default "clf"
+    classes : list or tuple, optional
+        String labels for the target classes, by default None
+    res_path : str, optional
+        Path to the directory where results will be saved, by default "results/mem_bin"
+    show : bool, optional
+        Whether to display plots, by default False
+    validation : bool, optional
+        Whether the compute object is for a validation set, by default False
+    name : str, optional
+        Name of the compute object, by default "ComputeClassifier"
     """
 
     def __init__(
         self,
         algorithm="clf",
-        classes=["2g", "8g", "16g", "64g"],
+        classes=None,
         res_path="results/mem_bin",
         show=False,
         validation=False,
@@ -714,7 +735,7 @@ class ComputeClassifier(Computer):
             name=name,
             **log_kws,
         )
-        self.classes = classes
+        self.classes = ["2g", "8g", "16g", "64g"] if classes is None else list(classes)
 
     def make_outputs(self, dl=True):
         """Store computed results into a dictionary, and optionally save to disk.
@@ -794,9 +815,7 @@ class ComputeClassifier(Computer):
         try:
             conf_idx = np.where(self.y_pred != self.test_idx.values)
         except AttributeError as e:
-            print(
-                f"Test/Val Index should be a pandas series, not {type(self.test_idx)}"
-            )
+            print(f"Test/Val Index should be a pandas series, not {type(self.test_idx)}")
             print(e)
             return
         pred_proba = np.asarray(self.model.predict(self.X_test).flatten(), "float32")
@@ -830,20 +849,38 @@ class ComputeBinary(ComputeClassifier):
 
     Parameters
     ----------
-    ComputeClassifier : Subclass object
-        spacekit.analyzer.compute.ComputeClassifier object
+    builder : ComputeClassifier object, optional
+        Existing ComputeClassifier object with instantiated attributes, by default None
+    algorithm : str, optional
+        Algorithm kind, by default "binary"
+    classes : list or tuple, optional
+        String labels for the target classes, by default None, by default None
+    res_path : str, optional
+        Path to store results, by default "results/svm"
+    show : bool, optional
+        Whether to display plots, by default False
+    validation : bool, optional
+        Whether to perform validation, by default False
+
+    Raises
+    ------
+    AttributeError
+        Raised when the `classes` parameter is not a list or tuple of exactly two strings.
     """
 
     def __init__(
         self,
         builder=None,
         algorithm="binary",
-        classes=["aligned", "misaligned"],
+        classes=None,
         res_path="results/svm",
         show=False,
         validation=False,
         **log_kws,
     ):
+        classes = ["aligned", "misaligned"] if classes is None else classes
+        if not isinstance(classes, (list, tuple)) or len(classes) != 2:
+            raise AttributeError("Binary classifier requires `classes` to be a list/tuple of exactly two strings to be used as target class names.")
         super().__init__(
             algorithm=algorithm,
             classes=classes,
@@ -892,15 +929,25 @@ class ComputeMulti(ComputeClassifier):
 
     Parameters
     ----------
-    ComputeClassifier : Subclass object
-        spacekit.analyzer.compute.ComputeClassifier object
+    builder : ComputeClassifier object, optional
+        Existing ComputeClassifier object with instantiated attributes, by default None
+    algorithm : str, optional
+        Algorithm kind, by default "multiclass"
+    classes : list or tuple, optional
+        String labels for the target classes, by default None
+    res_path : str, optional
+        Path to store results, by default "results/svm"
+    show : bool, optional
+        Whether to display plots, by default False
+    validation : bool, optional
+        Whether to perform validation, by default False
     """
 
     def __init__(
         self,
         builder=None,
         algorithm="multiclass",
-        classes=["2g", "8g", "16g", "64g"],
+        classes=None,
         res_path="results/mem_bin",
         show=False,
         validation=False,
@@ -951,9 +998,7 @@ class ComputeMulti(ComputeClassifier):
         )
         self.roc_auc = self.roc_auc_multi()
         self.acc_loss = self.acc_loss_scores()
-        self.cmx = confusion_matrix(
-            np.argmax(self.y_test, axis=-1), np.argmax(self.y_pred, axis=-1)
-        )
+        self.cmx = confusion_matrix(np.argmax(self.y_test, axis=-1), np.argmax(self.y_pred, axis=-1))
         self.cmx_norm = self.fusion_matrix(self.cmx, self.classes)[1]
         self.fnfp = self.fnfp_multi()
         if show_summary:
@@ -1009,9 +1054,7 @@ class ComputeMulti(ComputeClassifier):
         try:
             conf_idx = np.where(preds != actual)[0]
         except AttributeError as e:  # can probably remove this
-            print(
-                f"Test/Val Index should be a pandas series, not {type(self.test_idx)}"
-            )
+            print(f"Test/Val Index should be a pandas series, not {type(self.test_idx)}")
             print(e)
             return
         pred_proba = np.amax(self.y_scores, axis=-1)