swarm-seek 0.1.0__tar.gz

swarm_seek-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

swarm_seek-0.1.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: swarm-seek
+Version: 0.1.0
+Summary: Literature-validated Artificial Bee Colony optimization for Python
+Author-email: Travis Kessler <travis.j.kessler@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/tjkessler/swarm-seek
+Project-URL: Documentation, https://swarm-seek.readthedocs.io/
+Project-URL: Repository, https://github.com/tjkessler/swarm-seek
+Project-URL: Issues, https://github.com/tjkessler/swarm-seek/issues
+Keywords: artificial-bee-colony,abc,swarm-intelligence,optimization,metaheuristic,ask-tell
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2.0; extra == "dev"
+Requires-Dist: pytest>=8.4.0; extra == "dev"
+Requires-Dist: pytest-cov>=6.0.0; extra == "dev"
+Requires-Dist: ruff>=0.15.0; extra == "dev"
+Requires-Dist: pre-commit>=4.0.0; extra == "dev"
+Requires-Dist: nbmake>=0.5.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=8.0.0; extra == "docs"
+Requires-Dist: furo>=2024.8.6; extra == "docs"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "docs"
+Provides-Extra: numba
+Requires-Dist: numba>=0.59.0; extra == "numba"
+Provides-Extra: jax
+Requires-Dist: jax>=0.4.0; extra == "jax"
+Provides-Extra: sklearn
+Requires-Dist: scikit-learn>=1.3.0; extra == "sklearn"
+Provides-Extra: optuna
+Requires-Dist: optuna>=3.0.0; extra == "optuna"
+Dynamic: license-file
+
+# Swarm Seek
+
+Literature-validated Artificial Bee Colony (ABC) optimization for Python.
+
+Swarm Seek implements Original ABC and principal peer-reviewed continuous
+variants (GABC, qABC, MABC) with a NumPy core, an ask/tell API, and automated
+checks against published benchmark figures.
+
+**Status:** `0.1.0` (beta). Continuous ABC core, variants, ask/tell API, and
+literature oracles. Docs: https://swarm-seek.readthedocs.io/
+
+## Install
+
+Requires Python 3.10+.
+
+```bash
+pip install swarm-seek
+```
+
+Editable install for development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick start
+
+```python
+from swarm_seek import ABC, ContinuousSpace
+from swarm_seek.benchmarks import sphere
+
+space = ContinuousSpace([(-5.0, 5.0)] * 5)
+colony = ABC(space, variant="original", pop_size=20, limit=100, max_evals=5_000, seed=0)
+best = colony.minimize(sphere)
+print(best.fitness)
+```
+
+Ask/tell loop:
+
+```python
+import numpy as np
+
+from swarm_seek import ABC, ContinuousSpace
+from swarm_seek.benchmarks import sphere
+
+space = ContinuousSpace([(-5.0, 5.0)] * 5)
+colony = ABC(space, variant="gabc", pop_size=20, limit=100, max_evals=5_000, seed=0)
+
+while not colony.converged:
+    candidates = colony.ask()
+    if candidates.size == 0:
+        colony.tell([])
+        continue
+    colony.tell(np.asarray(sphere(candidates), dtype=np.float64))
+
+print(colony.best.fitness)
+```
+
+Runnable notebooks with stated pass criteria live in [`examples/`](examples/).
+Full documentation (variants, architecture, API, FAQ) builds from `docs/source/`.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).
+
+## Citation
+
+See [`CITATION.cff`](CITATION.cff) for citation metadata.

swarm_seek-0.1.0/README.md

@@ -0,0 +1,68 @@
+# Swarm Seek
+
+Literature-validated Artificial Bee Colony (ABC) optimization for Python.
+
+Swarm Seek implements Original ABC and principal peer-reviewed continuous
+variants (GABC, qABC, MABC) with a NumPy core, an ask/tell API, and automated
+checks against published benchmark figures.
+
+**Status:** `0.1.0` (beta). Continuous ABC core, variants, ask/tell API, and
+literature oracles. Docs: https://swarm-seek.readthedocs.io/
+
+## Install
+
+Requires Python 3.10+.
+
+```bash
+pip install swarm-seek
+```
+
+Editable install for development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick start
+
+```python
+from swarm_seek import ABC, ContinuousSpace
+from swarm_seek.benchmarks import sphere
+
+space = ContinuousSpace([(-5.0, 5.0)] * 5)
+colony = ABC(space, variant="original", pop_size=20, limit=100, max_evals=5_000, seed=0)
+best = colony.minimize(sphere)
+print(best.fitness)
+```
+
+Ask/tell loop:
+
+```python
+import numpy as np
+
+from swarm_seek import ABC, ContinuousSpace
+from swarm_seek.benchmarks import sphere
+
+space = ContinuousSpace([(-5.0, 5.0)] * 5)
+colony = ABC(space, variant="gabc", pop_size=20, limit=100, max_evals=5_000, seed=0)
+
+while not colony.converged:
+    candidates = colony.ask()
+    if candidates.size == 0:
+        colony.tell([])
+        continue
+    colony.tell(np.asarray(sphere(candidates), dtype=np.float64))
+
+print(colony.best.fitness)
+```
+
+Runnable notebooks with stated pass criteria live in [`examples/`](examples/).
+Full documentation (variants, architecture, API, FAQ) builds from `docs/source/`.
+
+## License
+
+Apache License 2.0. See [LICENSE](LICENSE).
+
+## Citation
+
+See [`CITATION.cff`](CITATION.cff) for citation metadata.

swarm_seek-0.1.0/pyproject.toml

@@ -0,0 +1,107 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "swarm-seek"
+dynamic = ["version"]
+description = "Literature-validated Artificial Bee Colony optimization for Python"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+authors = [
+    { name = "Travis Kessler", email = "travis.j.kessler@gmail.com" },
+]
+keywords = [
+    "artificial-bee-colony",
+    "abc",
+    "swarm-intelligence",
+    "optimization",
+    "metaheuristic",
+    "ask-tell",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Scientific/Engineering :: Mathematics",
+]
+dependencies = [
+    "numpy>=1.24.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "build>=1.2.0",
+    "pytest>=8.4.0",
+    "pytest-cov>=6.0.0",
+    "ruff>=0.15.0",
+    "pre-commit>=4.0.0",
+    "nbmake>=0.5.0",
+]
+docs = [
+    "sphinx>=8.0.0",
+    "furo>=2024.8.6",
+    "sphinx-copybutton>=0.5.2",
+]
+numba = [
+    "numba>=0.59.0",
+]
+jax = [
+    "jax>=0.4.0",
+]
+sklearn = [
+    "scikit-learn>=1.3.0",
+]
+optuna = [
+    "optuna>=3.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/tjkessler/swarm-seek"
+Documentation = "https://swarm-seek.readthedocs.io/"
+Repository = "https://github.com/tjkessler/swarm-seek"
+Issues = "https://github.com/tjkessler/swarm-seek/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+version = { attr = "swarm_seek.__version__" }
+
+[tool.ruff]
+target-version = "py310"
+line-length = 88
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v"
+markers = [
+    "slow: long-running literature oracles (deselect with '-m \"not slow\"')",
+]
+
+[tool.coverage.run]
+source = ["swarm_seek"]
+branch = true
+
+[tool.coverage.report]
+fail_under = 90
+show_missing = true
+skip_covered = false

swarm_seek-0.1.0/setup.cfg

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

swarm_seek-0.1.0/src/swarm_seek/__init__.py

@@ -0,0 +1,14 @@
+"""Swarm Seek: literature-validated Artificial Bee Colony optimization."""
+
+from swarm_seek.abc import ABC
+from swarm_seek.space import ContinuousSpace
+from swarm_seek.types import Solution
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "ABC",
+    "ContinuousSpace",
+    "Solution",
+    "__version__",
+]

swarm_seek-0.1.0/src/swarm_seek/abc.py

@@ -0,0 +1,144 @@
+"""Public Artificial Bee Colony façade."""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+from typing import Any
+
+import numpy as np
+
+from swarm_seek.backends import BackendProtocol
+from swarm_seek.colony import Colony
+from swarm_seek.errors import SwarmSeekError
+from swarm_seek.space import Space
+from swarm_seek.types import FloatArray, Sense, Solution
+from swarm_seek.variants import VariantStrategy
+
+
+class ABC:
+    """Ergonomic ask/tell façade around :class:`~swarm_seek.colony.Colony`.
+
+    Parameters match the design sketch: choose a registered ``variant``, a
+    ``space``, colony size / abandonment ``limit``, optimization ``sense``,
+    convergence budgets, RNG ``seed``, and execution ``backend``. Extra keyword
+    arguments are forwarded as variant parameters (e.g. ``C``, ``r``, ``MR``,
+    ``SF``).
+
+    Notes
+    -----
+    Power users may construct :class:`~swarm_seek.colony.Colony` directly.
+    ``minimize`` is convenience sugar over the ask/tell loop.
+    """
+
+    def __init__(
+        self,
+        space: Space,
+        *,
+        variant: str = "original",
+        strategy: VariantStrategy | None = None,
+        backend: BackendProtocol | str = "auto",
+        pop_size: int = 20,
+        limit: int = 100,
+        sense: Sense = "minimize",
+        max_evals: int | None = None,
+        max_iters: int | None = None,
+        stall_evals: int | None = None,
+        seed: int | None = None,
+        **variant_params: Any,
+    ) -> None:
+        self._colony = Colony(
+            space,
+            variant=variant if strategy is None else None,
+            strategy=strategy,
+            backend=backend,
+            pop_size=pop_size,
+            limit=limit,
+            sense=sense,
+            max_evals=max_evals,
+            max_iters=max_iters,
+            stall_evals=stall_evals,
+            seed=seed,
+            **variant_params,
+        )
+
+    @property
+    def colony(self) -> Colony:
+        """Underlying :class:`~swarm_seek.colony.Colony` engine."""
+        return self._colony
+
+    @property
+    def converged(self) -> bool:
+        """Whether a configured stopping criterion has been met."""
+        return self._colony.converged
+
+    @property
+    def best(self) -> Solution:
+        """Best solution found so far."""
+        return self._colony.best
+
+    @property
+    def n_evals(self) -> int:
+        """Objective evaluations consumed."""
+        return self._colony.n_evals
+
+    @property
+    def n_iters(self) -> int:
+        """Completed employed→onlooker→scout cycles."""
+        return self._colony.n_iters
+
+    def ask(self) -> FloatArray:
+        """Return candidates that need evaluation this step."""
+        return self._colony.ask()
+
+    def tell(self, fitnesses: FloatArray | list[float]) -> None:
+        """Consume objective values for the last ``ask`` batch."""
+        self._colony.tell(fitnesses)
+
+    def minimize(
+        self,
+        objective: Callable[[FloatArray], FloatArray | list[float]],
+        *,
+        max_evals: int | None = None,
+        max_iters: int | None = None,
+        stall_evals: int | None = None,
+    ) -> Solution:
+        """Run ask/tell until convergence and return the best solution.
+
+        Parameters
+        ----------
+        objective
+            Callable mapping candidate array ``(n, d)`` to fitnesses ``(n,)``.
+        max_evals, max_iters, stall_evals
+            Optional budget overrides applied only when the colony has not yet
+            started (no ``tell`` yet). If the run already started, existing
+            colony budgets are used and overrides are rejected.
+
+        Returns
+        -------
+        Solution
+            Best solution at termination.
+        """
+        if max_evals is not None or max_iters is not None or stall_evals is not None:
+            try:
+                self._colony.configure_budgets(
+                    max_evals=max_evals,
+                    max_iters=max_iters,
+                    stall_evals=stall_evals,
+                )
+            except SwarmSeekError as exc:
+                msg = (
+                    "Budget overrides to minimize() are only allowed before "
+                    "the first ask/tell."
+                )
+                if "before the first ask" in str(exc):
+                    raise SwarmSeekError(msg) from exc
+                raise
+
+        while not self._colony.converged:
+            candidates = self._colony.ask()
+            if candidates.size == 0:
+                self._colony.tell([])
+                continue
+            fitnesses = np.asarray(objective(candidates), dtype=np.float64)
+            self._colony.tell(fitnesses)
+        return self._colony.best

swarm_seek-0.1.0/src/swarm_seek/backends/__init__.py

@@ -0,0 +1,11 @@
+"""Execution backends for population array operations (NumPy default)."""
+
+from swarm_seek.backends.numpy_backend import NumpyBackend
+from swarm_seek.backends.protocol import BackendProtocol
+from swarm_seek.backends.registry import get_backend
+
+__all__ = [
+    "BackendProtocol",
+    "NumpyBackend",
+    "get_backend",
+]