SKSurrogate 0.1.0__tar.gz → 0.2.0__tar.gz

sksurrogate-0.2.0/License.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Mehdi Ghasemi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sksurrogate-0.2.0/MANIFEST.in

@@ -0,0 +1,10 @@
+include readme.rst
+include License.txt
+include requirements.txt
+include docs/*.rst
+include docs/conf.py
+include docs/Makefile
+include docs/make.bat
+include docs/images/*
+recursive-include examples *.py
+recursive-include tests *.py conftest.py

{sksurrogate-0.1.0/SKSurrogate.egg-info → sksurrogate-0.2.0}/PKG-INFO

@@ -1,35 +1,56 @@
 Metadata-Version: 2.4
 Name: SKSurrogate
-Version: 0.1.0
+Version: 0.2.0
 Summary: A python package that implements or wraps a few machine learning tools Scikit-Learn style.
 Home-page: https://github.com/mghasemi/sksurrogate.git
 Author: Mehdi Ghasemi
 Author-email: mehdi.ghasemi@gmail.com
-License: MIT License
+License: MIT
 Keywords: Auto Machine Learning,AutoML,Optimization,Surrogate Optimization,Numerical,Machine Learning,Regression,Random Search
-Requires-Dist: numpy
-Requires-Dist: scipy
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+Requires-Dist: numpy>=1.22
+Requires-Dist: scipy>=1.10
 Requires-Dist: pandas
 Requires-Dist: matplotlib
-Requires-Dist: scikit-learn
+Requires-Dist: scikit-learn>=1.5
 Requires-Dist: SALib
 Requires-Dist: imbalanced-learn
-Requires-Dist: joblib
+Requires-Dist: joblib>=1.2
 Requires-Dist: eli5
 Requires-Dist: skrebate
-Requires-Dist: tqdm
+Requires-Dist: tqdm>=4.66.3
 Requires-Dist: peewee
 Requires-Dist: category_encoders
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pygments; extra == "test"
+Provides-Extra: benchmark
+Requires-Dist: openml<0.16,>=0.15; extra == "benchmark"
+Requires-Dist: optuna; extra == "benchmark"
 Dynamic: author
 Dynamic: author-email
+Dynamic: classifier
 Dynamic: description
+Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: provides-extra
 Dynamic: requires-dist
+Dynamic: requires-python
 Dynamic: summary
 
-|Quality| |Doc| |Licence|
+|CI| |Doc| |Licence|
 
 |Logo|
 
@@ -39,9 +60,10 @@ SKSurrogate
 functions based on ``scikit-learn``. The main purpose of ``SKSurrogate`` is to facilitate
 hyperparameter optimization for machine learning models and optimized pipeline design (AutoML).
 
-The version of the surrogate optimization implemented here heavily relies on regressors.
-A custom regressor based on Hilbert Space techniques is implemented, but all ``scikit-learn``
-regressors are accepted for optimization.
+The version of the surrogate optimization implemented here heavily relies on regressors. Since v0.2 the default
+response surface is a stock, un-tuned RBF Gaussian process (chosen over the previous cubic Hilbert polynomial
+on the evidence of the equal-budget benchmark suite); a custom regressor based on Hilbert Space techniques is
+still available (`HilbertRegressor`), and all ``scikit-learn`` regressors are accepted for optimization.
 
 Finding an optimized pipeline -based on a given list of transformers and estimators is
 a time-consuming task. A version of evolutionary optimization has been implemented to reduce
@@ -130,8 +152,8 @@ MIT License
     SOFTWARE.
 
 .. |Logo| image:: ./docs/images/funnel.png
-.. |Quality| image:: https://api.codacy.com/project/badge/Grade/9a4d3e663cb04128a06d47efc85f23da
-    :target: https://www.codacy.com/app/mghasemi/sksurrogate?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=mghasemi/sksurrogate&amp;utm_campaign=Badge_Grade
+.. |CI| image:: https://github.com/mghasemi/sksurrogate/actions/workflows/ci.yml/badge.svg?branch=master
+    :target: https://github.com/mghasemi/sksurrogate/actions/workflows/ci.yml
 .. |Doc| image:: https://readthedocs.org/projects/sksurrogate/badge/?version=latest
     :target: https://sksurrogate.readthedocs.io/en/latest/?badge=latest
     :alt: Documentation Status

{sksurrogate-0.1.0 → sksurrogate-0.2.0}/SKSurrogate/__init__.py

@@ -47,6 +47,8 @@ from .monitoring import (
 from .retraining import RetrainingJob
 from .synthdat import SynthData
 
+__version__ = "0.2.0"
+
 __all__ = [
     "AML",
     "BoxSample",

{sksurrogate-0.1.0 → sksurrogate-0.2.0}/SKSurrogate/aml.py

@@ -229,7 +229,12 @@ default_config = {
             "class_weight": HDReal((1.0e-5, 1.0e-5), (20.0, 20.0)),
         },
         "sklearn.linear_model.LogisticRegression": {
-            "penalty": Categorical(["l1", "l2"]),
+            # sklearn >= 1.8: 'penalty' is deprecated (removed in 1.10); L1/L2
+            # are now selected via l1_ratio, which constrains the solver
+            # (L1 needs liblinear/saga). The invalid (lbfgs, l1) cell is a
+            # forbidden combination handled by structsearch's fallback.
+            "solver": Categorical(["lbfgs", "liblinear"]),
+            "l1_ratio": Categorical([0.0, 1.0]),
             "C": Real(1.0e-6, 10.0),
             "class_weight": HDReal((1.0e-5, 1.0e-5), (20.0, 20.0))
             # 'dual': Categorical([True, False])

{sksurrogate-0.1.0 → sksurrogate-0.2.0}/SKSurrogate/structsearch.py

@@ -21,8 +21,11 @@ optimization problem with :math:`f` replaced by :math:`\hat{f}` one gets a more
 :math:`x_i` for the next iteration. If a certain number of iterations do not result in a better candidate,
 the method returns to random sampling to collect more information about :math:`f`. The surrogate
 function :math:`\hat{f}_i` can be found in many ways such as (non)linear regression, Gaussian
-process regression, etc. and  `SurrogateSearch` do not have a preference. But by default it uses a polynomial
-regression of degree 3 if no regressor is provided. Any regressor following the architecture of `scikit-learn`
+process regression, etc. and  `SurrogateSearch` do not have a preference. But by default (since v0.2) it fits an
+un-tuned RBF Gaussian process (`sklearn.gaussian_process.GaussianProcessRegressor`), chosen over the legacy cubic
+Hilbert polynomial on the evidence of the equal-budget benchmark suite — see `benchmarks/DESIGN.md` sec. 12 and raw
+records DOI 10.5281/zenodo.23629024; the Hilbert surface remains available via
+`regressor=HilbertRegressor(deg=...)`. Any regressor following the architecture of `scikit-learn`
 is acceptable. Note that regressors usually require a minimum number of data points to function properly.
 
 There are various ways for sampling a random point in feasible space which affects the performance of SRS.
@@ -195,10 +198,12 @@ class SurrogateSearch(object):
     :param sampling: the sampling method either `BoxSample` or `SphereSample` (default `SphereSample`)
     :param search_sphere: `boolean` whether to fit the surrogate function on a neighbourhood of current candidate or
         over all sampled points (default: False)
-    :param deg: `int` degree of polynomial regressor if one chooses to fit polynomial surrogates (default: 3)
+    :param deg: `int` degree used to compute the default minimum number of evaluations (default: 3); if you pass your own
+        polynomial surface, e.g. `regressor=HilbertRegressor(deg=...)`, that object's degree governs instead
     :param min_evals: `int` minimum number of samples before fitting a surrogate (default will be calculated as if the
         surrogate is a polynomial of degree 3)
-    :param regressor: a regressor (scikit-learn style) to find a surrogate
+    :param regressor: a regressor (scikit-learn style) to find a surrogate; default since v0.2 is an un-tuned RBF
+        `GaussianProcessRegressor` — pass e.g. `HilbertRegressor(deg=3)` for the legacy cubic polynomial surface
     :param scipy_solver: `str` the scipy solver ('COBYLA' or 'SLSQP') to solve the local optimization problem at each
         iteration (default: 'COBYLA')
     :param max_itr_no_prog: `int` maximum number of iterations with no progress (default: infinity)
@@ -265,9 +270,16 @@ class SurrogateSearch(object):
         self.termination_reason = None
         self.summary_ = {}
         if self.regressor is None:
-            from .NpyProximation import HilbertRegressor
-
-            self.regressor = HilbertRegressor(deg=3)
+            # Default response surface since v0.2: stock, un-tuned RBF Gaussian process.
+            # Evidence: equal-budget benchmark suite (benchmarks/DESIGN.md sec. 12; raw
+            # records DOI 10.5281/zenodo.23629024) -- top mean CV on all six datasets at
+            # both B=30 and B=60 vs the legacy cubic Hilbert default (seed-level wins
+            # 20W/17T/5L and 25W/13T/4L). The MinEvals combinatorial floor below is kept
+            # identical to v0.1 so surrogate firing matches that benchmark configuration;
+            # pass regressor=HilbertRegressor(deg=<deg>) for the legacy surface.
+            from sklearn.gaussian_process import GaussianProcessRegressor
+
+            self.regressor = GaussianProcessRegressor()
             new_n_evals = binom(n_ + 3, n_)
             if self.MinEvals < new_n_evals:
                 self.MinEvals = new_n_evals
@@ -677,6 +689,9 @@ class SurrogateRandomCV(BaseSearchCV):
         ``n_points`` if you want to try more parameter settings in parallel.
     :param min_evals: int, default=25; Number of random evaluations before employing an approximation for the
         response surface.
+    :param regressor: scikit-learn-style regressor used to fit the surrogate response surface;
+        default since v0.2 is an un-tuned RBF `GaussianProcessRegressor` (see
+        `benchmarks/DESIGN.md` sec. 12), pass e.g. `HilbertRegressor(deg=3)` for the legacy cubic polynomial.
     :param n_jobs: int, default=-1; number of processes to run in parallel
     :param fit_params: dict, optional; Parameters to pass to the fit method.
     :param pre_dispatch: int, or string, optional;
@@ -1307,9 +1322,10 @@ class SurrogateRandomCV(BaseSearchCV):
                 best_params_[param] = cls_dict
         # The optimizer's solution can land inside a region every trial rejected
         # (a forbidden combination, or a candidate whose folds all failed).
-        # Refitting those settings either raises (e.g. lbfgs with penalty='l1')
-        # or silently returns a banned model, so fall back to the best trial that
-        # was actually completed; when no trial was, skip the refit entirely.
+        # Refitting those settings either raises (e.g. an invalid
+        # solver/regularization combination) or silently returns a banned
+        # model, so fall back to the best trial that was actually completed;
+        # when no trial was, skip the refit entirely.
         from numpy import isfinite
 
         feasible = [

sksurrogate-0.2.0/SKSurrogate.egg-info/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: SKSurrogate
+Version: 0.2.0
+Summary: A python package that implements or wraps a few machine learning tools Scikit-Learn style.
+Home-page: https://github.com/mghasemi/sksurrogate.git
+Author: Mehdi Ghasemi
+Author-email: mehdi.ghasemi@gmail.com
+License: MIT
+Keywords: Auto Machine Learning,AutoML,Optimization,Surrogate Optimization,Numerical,Machine Learning,Regression,Random Search
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+Requires-Dist: numpy>=1.22
+Requires-Dist: scipy>=1.10
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Requires-Dist: scikit-learn>=1.5
+Requires-Dist: SALib
+Requires-Dist: imbalanced-learn
+Requires-Dist: joblib>=1.2
+Requires-Dist: eli5
+Requires-Dist: skrebate
+Requires-Dist: tqdm>=4.66.3
+Requires-Dist: peewee
+Requires-Dist: category_encoders
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pygments; extra == "test"
+Provides-Extra: benchmark
+Requires-Dist: openml<0.16,>=0.15; extra == "benchmark"
+Requires-Dist: optuna; extra == "benchmark"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+|CI| |Doc| |Licence|
+
+|Logo|
+
+SKSurrogate
+==================
+``SKSurrogate`` is a suite of tools which implements surrogate optimization for expensive
+functions based on ``scikit-learn``. The main purpose of ``SKSurrogate`` is to facilitate
+hyperparameter optimization for machine learning models and optimized pipeline design (AutoML).
+
+The version of the surrogate optimization implemented here heavily relies on regressors. Since v0.2 the default
+response surface is a stock, un-tuned RBF Gaussian process (chosen over the previous cubic Hilbert polynomial
+on the evidence of the equal-budget benchmark suite); a custom regressor based on Hilbert Space techniques is
+still available (`HilbertRegressor`), and all ``scikit-learn`` regressors are accepted for optimization.
+
+Finding an optimized pipeline -based on a given list of transformers and estimators is
+a time-consuming task. A version of evolutionary optimization has been implemented to reduce
+its time in lieu of global optimality.
+
+``SKSurrogate`` is positioned as a scientific/research library: the numerical methods are
+validated against benchmarks, but the API surface evolves with ongoing research work.
+
+Installation
+------------
+From PyPI::
+
+    pip install sksurrogate
+
+or from source (development)::
+
+    pip install git+https://github.com/mghasemi/sksurrogate.git
+
+Data identity and schema validation
+-----------------------------------
+``SKSurrogate`` now records a deterministic dataset fingerprint and a JSON-serializable schema
+for each tracked dataset. Each call to ``mltrack.RegisterData(...)`` stores dataset metadata,
+including the target column, row count, column names, dtypes, nullability, and categorical values.
+This allows a run to be identified and later compared against a different dataset or a refreshed
+training sample.
+
+The tracker also exposes ``validate_data(...)`` and ``validate_prediction_data(...)`` to compare
+incoming data against the stored schema before training or inference. By default the checks are
+strict: missing columns, reordered columns, dtype mismatches, and unknown categorical values fail
+with actionable errors. For compatibility workflows, these checks can be relaxed explicitly with
+``missing_columns='ignore'`` or ``unknown_categories='ignore'``.
+
+The intended workflow is:
+
+1. Register the training dataset with ``mltrack.RegisterData(frame, target)``.
+2. Validate training data before fitting with ``tracker.validate_data(frame, target=...)``.
+3. Validate prediction inputs with ``tracker.validate_prediction_data(frame)`` before calling
+   ``predict`` on a model or pipeline.
+4. Use the stored ``dataset_fingerprint`` and ``dataset_schema`` metadata for reproducibility,
+   drift checks, and auditability.
+
+Dependencies
+----------------
+``SKSurrogate`` heavily depends on `NumPy <http://www.numpy.org/>`_,
+`scipy <https://www.scipy.org/>`_, and `scikit-learn <https://scikit-learn.org/stable/>`_,
+for its main functionalities. Other dependencies include `pandas <https://pandas.pydata.org/>`_,
+`matplotlib <https://matplotlib.org/>`_, `SALib <https://github.com/SALib/SALib>`_,
+`peewee <https://github.com/coleifer/peewee>`_, and
+`tqdm <https://github.com/tqdm/tqdm>`_.
+
+Documentation
+----------------
+The documentation is produced by `Sphinx <http://www.sphinx-doc.org/en/stable/>`_ and is intended to cover code usage
+as well as a bit of theory to explain each method briefly.
+For more details refer to the documentation at `sksurrogate.rtfd.io <http://sksurrogate.readthedocs.io/>`_.
+The optional web UI and control-plane API are documented in the
+`Web UI and Control-Plane API guide <https://sksurrogate.readthedocs.io/en/latest/controlplane.html>`_.
+The `step-by-step UI manual <https://sksurrogate.readthedocs.io/en/latest/ui-manual.html>`_
+includes screenshots and example CSV files.
+
+License
+================
+This code is distributed under `MIT license <https://en.wikipedia.org/wiki/MIT_License>`_:
+
+MIT License
+----------------
+
+    Copyright (c) 2019 Mehdi Ghasemi
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE.
+
+.. |Logo| image:: ./docs/images/funnel.png
+.. |CI| image:: https://github.com/mghasemi/sksurrogate/actions/workflows/ci.yml/badge.svg?branch=master
+    :target: https://github.com/mghasemi/sksurrogate/actions/workflows/ci.yml
+.. |Doc| image:: https://readthedocs.org/projects/sksurrogate/badge/?version=latest
+    :target: https://sksurrogate.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+.. |Licence| image:: https://img.shields.io/badge/license-MIT-blue.svg
+   :target: https://github.com/mghasemi/sksurrogate/blob/master/License.txt

sksurrogate-0.2.0/SKSurrogate.egg-info/SOURCES.txt

@@ -0,0 +1,95 @@
+License.txt
+MANIFEST.in
+readme.rst
+requirements.txt
+setup.py
+SKSurrogate/DataProcess.py
+SKSurrogate/NpyProximation.py
+SKSurrogate/__init__.py
+SKSurrogate/aml.py
+SKSurrogate/ci.py
+SKSurrogate/deployment.py
+SKSurrogate/eoa.py
+SKSurrogate/execution.py
+SKSurrogate/inference.py
+SKSurrogate/mltrace.py
+SKSurrogate/modelbundle.py
+SKSurrogate/monitoring.py
+SKSurrogate/retraining.py
+SKSurrogate/sensapprx.py
+SKSurrogate/structsearch.py
+SKSurrogate/synthdat.py
+SKSurrogate.egg-info/PKG-INFO
+SKSurrogate.egg-info/SOURCES.txt
+SKSurrogate.egg-info/dependency_links.txt
+SKSurrogate.egg-info/entry_points.txt
+SKSurrogate.egg-info/requires.txt
+SKSurrogate.egg-info/top_level.txt
+docs/Makefile
+docs/code.rst
+docs/conf.py
+docs/controlplane.rst
+docs/dataproc.rst
+docs/eoa.rst
+docs/hilbert.rst
+docs/index.rst
+docs/inference.rst
+docs/intro.rst
+docs/make.bat
+docs/mltrace.rst
+docs/modelbundles.rst
+docs/monitoring.rst
+docs/opd.rst
+docs/phase10.rst
+docs/phase9.rst
+docs/release.rst
+docs/sensitivity.rst
+docs/surrogate.rst
+docs/ui-manual.rst
+docs/images/best1.png
+docs/images/best10.png
+docs/images/best11.png
+docs/images/best12.png
+docs/images/best2.png
+docs/images/best3.png
+docs/images/best4.png
+docs/images/best5.png
+docs/images/best6.png
+docs/images/best7.png
+docs/images/best8.png
+docs/images/best9.png
+docs/images/correlations.png
+docs/images/funnel.png
+docs/images/lego.png
+docs/images/points.png
+docs/images/points_fit_optm.png
+docs/images/polyreg.png
+docs/images/ui-bundles.png
+docs/images/ui-dashboard.png
+docs/images/ui-datasets.png
+docs/images/ui-evaluation.png
+docs/images/ui-experiments.png
+docs/images/ui-features.png
+docs/images/ui-inference.png
+docs/images/ui-jobs.png
+docs/images/ui-monitoring.png
+docs/images/ui-quality-gates.png
+docs/images/ui-registry.png
+docs/images/ui-retraining.png
+docs/images/ui-settings.png
+docs/images/weights.png
+examples/benchmark_phase10.py
+examples/example01.py
+examples/example02.py
+examples/example03_mltrace.py
+examples/example04_end_to_end.py
+examples/example05_full_classification.py
+examples/example06_full_regression.py
+tests/test_optimized_paths.py
+tests/test_phase1_endpoints.py
+tests/test_phase2_endpoints.py
+tests/test_phase3_endpoints.py
+tests/test_phase4_endpoints.py
+tests/test_phase5_endpoints.py
+tests/test_phase6_endpoints.py
+tests/test_phase7_endpoints.py

sksurrogate-0.2.0/SKSurrogate.egg-info/requires.txt

@@ -0,0 +1,21 @@
+numpy>=1.22
+scipy>=1.10
+pandas
+matplotlib
+scikit-learn>=1.5
+SALib
+imbalanced-learn
+joblib>=1.2
+eli5
+skrebate
+tqdm>=4.66.3
+peewee
+category_encoders
+
+[benchmark]
+openml<0.16,>=0.15
+optuna
+
+[test]
+pytest
+pygments

sksurrogate-0.2.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = SKSurrogate
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

sksurrogate-0.2.0/docs/code.rst

@@ -0,0 +1,61 @@
+Code Documentation
+=================================
+
+This reference covers the public ``SKSurrogate`` API that users are expected to
+import from the package root. The package exposes the stable automation and
+tracking interfaces directly, while the internal implementation modules remain
+available for advanced usage.
+
+.. currentmodule:: SKSurrogate
+
+.. automodule:: SKSurrogate
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+The package also exposes the major implementation modules for advanced users:
+
+.. automodule:: SKSurrogate.structsearch
+   :members:
+
+.. automodule:: SKSurrogate.eoa
+   :members:
+
+.. automodule:: SKSurrogate.NpyProximation
+   :members:
+
+.. automodule:: SKSurrogate.sensapprx
+   :members:
+
+.. automodule:: SKSurrogate.aml
+   :members:
+
+.. automodule:: SKSurrogate.mltrace
+   :members:
+
+.. automodule:: SKSurrogate.modelbundle
+   :members:
+
+.. automodule:: SKSurrogate.inference
+   :members:
+
+.. automodule:: SKSurrogate.monitoring
+   :members:
+
+.. automodule:: SKSurrogate.execution
+   :members:
+
+.. automodule:: SKSurrogate.ci
+   :members:
+
+.. automodule:: SKSurrogate.retraining
+   :members:
+
+.. automodule:: SKSurrogate.deployment
+   :members:
+
+.. automodule:: SKSurrogate.DataProcess
+   :members:
+
+.. automodule:: SKSurrogate.synthdat
+   :members: