gfdl 0.1.0__tar.gz

gfdl-0.1.0/COPYING

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025-2026 Los Alamos National Laboratory.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

gfdl-0.1.0/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: gfdl
+Version: 0.1.0
+Summary: Gradient Free Deep Learning (GFDL) networks including single and multi layer random vector functional link (RVFL) networks and extreme learning machines (ELMs)
+Project-URL: source, https://github.com/lanl/GFDL
+Project-URL: download, https://github.com/lanl/GFDL/releases
+Project-URL: tracker, https://github.com/lanl/GFDL/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Scientific/Engineering
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS
+Requires-Python: >=3.12
+License-File: COPYING
+Requires-Dist: numpy<2.7,>=2.0.0
+Requires-Dist: scikit-learn<1.11,>=1.5.0
+Requires-Dist: scipy<1.20,>=1.13.0
+Requires-Dist: packaging<27.0,>=24.0
+Provides-Extra: test
+Requires-Dist: ucimlrepo; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Dynamic: license-file

gfdl-0.1.0/README.md

@@ -0,0 +1,32 @@
+# Gradient Free Deep Learning (GFDL) -- LANL O5013 
+
+## Introduction
+This is a Python library that provides a variety of `scikit-learn` conformant
+machine learning estimators that do not use backpropagation. The most
+prominent estimator types we support provide access to single and multi layer
+random vector functional link (RVFL) networks and extreme learning machines
+(ELMs). There is a considerable background literate on these two types
+of gradient free networks, and one obvious advantage of being gradient free
+is that expensive hardware devices are not required to train the models
+efficiently.
+
+## Contribution Guidelines
+
+1. We use an open source license that is compatible with the rest of the
+scientific Python ecosystem, so please do not provide contributions that
+have a potential to be copyleft. For example, do not copy or even read code
+from libraries that have a GPL or other copyleft-style license, as we cannot
+accept it while retaining our more liberal software license.
+2. At the moment it is not acceptable to use machine learning/AI/LLMs as
+part of the code contribution/review process. The reason is related to provenance
+and licensing---we cannot know for sure if the material being contributed
+originated or partially originated from code that had a copyleft license.
+3. Please make an effort to format your PR titles and commit messages
+according to the [guidelines used provided by NumPy](https://numpy.org/devdocs/dev/development_workflow.html#writing-the-commit-message). This helps keep our commit
+history readable and easier to debug.
+4. Please try to avoid merging your own code---we aim to provide timely
+code reviews and have developers merge the code of others when they are
+satisfied.
+5. Please add regression tests for bug fixes and new features, and avoid
+making unrelated changes (i.e., formatting changes to other parts of the
+code alongside a bug fix or improvement).

gfdl-0.1.0/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["setuptools>=69,<80.11.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "gfdl"
+version = "0.1.0"
+description = "Gradient Free Deep Learning (GFDL) networks including single and multi layer random vector functional link (RVFL) networks and extreme learning machines (ELMs)"
+requires-python = ">=3.12"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Scientific/Engineering",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: POSIX",
+    "Operating System :: Unix",
+    "Operating System :: MacOS",
+]
+dependencies = ["numpy>=2.0.0,<2.7",
+                "scikit-learn>=1.5.0,<1.11",
+                "scipy>=1.13.0,<1.20",
+                "packaging>=24.0,<27.0"]
+
+[project.urls]
+source = "https://github.com/lanl/GFDL"
+download = "https://github.com/lanl/GFDL/releases"
+tracker = "https://github.com/lanl/GFDL/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+gfdl = ["testdata/**/*"]
+
+
+[project.optional-dependencies]
+test = [
+    "ucimlrepo",
+    "pytest",
+    "pytest-cov",
+]
+
+[tool.numpydoc_validation]
+checks = [
+    "all", # report on all checks, except the below
+    "EX01", # we don't require examples sections yet
+    "SA01", # we don't require "See Also" sections
+    "ES01", # we don't require extended summaries
+]
+
+exclude = [
+    '\.__init__$',
+    '\._check_voting$',
+    '\._forward$',
+    'EnsembleGFDL(\.|$)', # ignore base class
+    'GFDL(\.|$)', # ignore base class
+]

gfdl-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

gfdl-0.1.0/src/gfdl/__init__.py

@@ -0,0 +1,36 @@
+import platform
+
+import numpy as np
+import packaging
+import scipy
+import sklearn
+from packaging.version import Version
+
+from .model import GFDL
+
+__all__ = ["GFDL"]
+
+packaging_version = Version(packaging.__version__)
+min_packaging_version = "24.0"
+if packaging_version < Version(min_packaging_version):
+    raise ImportError(f"{packaging_version=}, but {min_packaging_version=}")
+
+python_version = Version(platform.python_version())
+min_python_version = "3.12"
+if python_version < Version(min_python_version):
+    raise ImportError(f"{python_version=}, but {min_python_version=}")
+
+numpy_version = Version(np.__version__)
+min_numpy_version = "2.0.0"
+if numpy_version < Version(min_numpy_version):
+    raise ImportError(f"{numpy_version=}, but {min_numpy_version=}")
+
+sklearn_version = Version(sklearn.__version__)
+min_sklearn_version = "1.5.0"
+if sklearn_version < Version(min_sklearn_version):
+    raise ImportError(f"{sklearn_version=}, but {min_sklearn_version=}")
+
+scipy_version = Version(scipy.__version__)
+min_scipy_version = "1.13.0"
+if scipy_version < Version(min_scipy_version):
+    raise ImportError(f"{scipy_version=}, but {min_scipy_version=}")

gfdl-0.1.0/src/gfdl/activations.py

@@ -0,0 +1,194 @@
+"""
+Activation functions for Gradient Free Deep Learning estimators.
+"""
+
+import numpy as np
+import scipy
+
+
+def relu(z):
+    """
+    The rectified linear unit activation function.
+
+    Parameters
+    ----------
+    z : array_like
+        Input array.
+
+    Returns
+    -------
+    numpy.ndarray
+        The output array with only positive values.
+    """
+    return np.maximum(0, z)
+
+
+def tanh(z):
+    """
+    The hyperbolic tangent activation function.
+
+    Parameters
+    ----------
+    z : array_like
+        Input array.
+
+    Returns
+    -------
+    numpy.ndarray
+        The output array with hyperbolic tangent values.
+
+    See Also
+    --------
+    numpy.tanh : The hyperbolic tangent function.
+    """
+    return np.tanh(z)
+
+
+def sigmoid(z):
+    """
+    The logistic sigmoid activation function.
+
+    Parameters
+    ----------
+    z : array_like
+        Input array.
+
+    Returns
+    -------
+    numpy.ndarray
+        The output array with the function values.
+
+    See Also
+    --------
+    scipy.special.expit : The logistic sigmoid function.
+    """
+    return scipy.special.expit(z)
+
+
+def identity(z):
+    """
+    The identity activation function.
+
+    Parameters
+    ----------
+    z : array_like
+        Input array.
+
+    Returns
+    -------
+    numpy.ndarray
+        The input array is returned unchanged.
+    """
+    return z
+
+
+def softmax(z):
+    """
+    The softmax activation function.
+
+    Parameters
+    ----------
+    z : array_like
+        Input array.
+
+    Returns
+    -------
+    numpy.ndarray
+        The output array with the function values.
+
+    See Also
+    --------
+    scipy.special.softmax : The softmax function.
+    """
+    return scipy.special.softmax(z, axis=-1)
+
+
+def softmin(z):
+    """
+    The softmin activation function.
+
+    It is the softmax function applied to negative of the input values.
+
+    Parameters
+    ----------
+    z : array_like
+        Input array.
+
+    Returns
+    -------
+    numpy.ndarray
+        The output array with the function values.
+
+    See Also
+    --------
+    scipy.special.softmax : The softmax function.
+    """
+    return softmax(-z)
+
+
+def log_sigmoid(z):
+    """
+    The logarithm of logistic sigmoid activation function.
+
+    Parameters
+    ----------
+    z : array_like
+        Input array.
+
+    Returns
+    -------
+    numpy.ndarray
+        The output array with the function values.
+
+    See Also
+    --------
+    scipy.special.log_expit : The logistic sigmoid function.
+    """
+    return scipy.special.log_expit(z)
+
+
+def log_softmax(z):
+    """
+    The log softmax activation function.
+
+    Parameters
+    ----------
+    z : array_like
+        Input array.
+
+    Returns
+    -------
+    numpy.ndarray
+        The output array with the function values.
+
+    See Also
+    --------
+    scipy.special.log_softmax : The logarithm of softmax function.
+    """
+    return scipy.special.log_softmax(z, axis=-1)
+
+
+ACTIVATIONS = {
+    "relu": relu,
+    "tanh": tanh,
+    "sigmoid": sigmoid,
+    "identity": identity,
+    "linear": identity,
+    "softmax": softmax,
+    "softmin": softmin,
+    "log_sigmoid": log_sigmoid,
+    "log_softmax": log_softmax,
+}
+
+
+def resolve_activation(activation):
+    # numpydoc ignore=GL08
+    name = activation.strip().lower()
+    try:
+        fn = ACTIVATIONS[name]
+    except KeyError as e:
+        allowed = sorted(ACTIVATIONS.keys())
+        raise ValueError(
+            f"activation='{activation}' is not supported; choose from {allowed}"
+        ) from e
+    return name, fn