smx
===

.. py:module:: smx

.. autoapi-nested-parse::

   SMX — Spectral Model Explanation
   =================================
   Public API for the SMX core algorithm library.

   Typical usage
   -------------
   >>> import smx
   >>> zones = smx.extract_spectral_zones(Xcal, cuts)
   >>> agg = smx.ZoneAggregator(method='pca')
   >>> scores_df = agg.fit_transform(zones)
   >>> gen = smx.PredicateGenerator(quantiles=[0.25, 0.5, 0.75])
   >>> gen.fit(scores_df)
   >>> bagger = smx.PredicateBagger()
   >>> bags = bagger.run(scores_df, y_pred, gen.predicates_df_)
   >>> metric = smx.CovarianceMetric(threshold=0.01)
   >>> rankings = metric.compute(bags)
   >>> builder = smx.PredicateGraphBuilder()
   >>> graph = builder.build(bags, rankings, metric_column='Covariance')
   >>> lrc_df = smx.compute_lrc(graph, gen.predicates_df_)



Submodules
----------

.. toctree::
   :maxdepth: 1

   /api/smx/datasets/index
   /api/smx/evaluation/index
   /api/smx/graph/index
   /api/smx/pipeline/index
   /api/smx/plotting/index
   /api/smx/predicates/index
   /api/smx/zones/index