ecabc 3.0.0__tar.gz → 3.0.2__tar.gz

ecabc-3.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018-2026 Sanskriti Sharma, Hernan Gelaf-Romer, Travis Kessler
+
+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.

ecabc-3.0.2/PKG-INFO

@@ -0,0 +1,272 @@
+Metadata-Version: 2.4
+Name: ecabc
+Version: 3.0.2
+Summary: Artificial bee colony for function parameter optimization
+Author-email: Sanskriti Sharma <Sanskriti_Sharma@student.uml.edu>, Hernan Gelaf-Romer <Hernan_Gelafromer@student.uml.edu>, Travis Kessler <travis.j.kessler@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/ecrl/ecabc
+Project-URL: Bug Tracker, https://github.com/ecrl/ecabc/issues
+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: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-cov>=5; extra == "dev"
+Requires-Dist: ruff>=0.8; extra == "dev"
+Requires-Dist: mypy>=1.8; extra == "dev"
+Requires-Dist: pre-commit>=4; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7; extra == "docs"
+Requires-Dist: furo>=2024.1; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints>=2; extra == "docs"
+Requires-Dist: sphinx-copybutton>=0.5; extra == "docs"
+Dynamic: license-file
+
+[![UML Energy & Combustion Research Laboratory](https://sites.uml.edu/hunter-mack/files/2021/11/ECRL_final.png)](http://faculty.uml.edu/Hunter_Mack/)
+
+# ECabc: optimization algorithm for tuning user-defined parametric functions
+[![GitHub version](https://badge.fury.io/gh/ECRL%2FECabc.svg)](https://badge.fury.io/gh/ECRL%2FECabc)
+[![PyPI version](https://badge.fury.io/py/ecabc.svg)](https://badge.fury.io/py/ecabc)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ECRL/ecabc/blob/master/LICENSE)
+[![CI](https://github.com/ecrl/ecabc/actions/workflows/run_tests.yml/badge.svg?branch=master)](https://github.com/ecrl/ecabc/actions/workflows/run_tests.yml)
+[![DOI](http://joss.theoj.org/papers/10.21105/joss.01420/status.svg)](https://doi.org/10.21105/joss.01420)
+
+**ECabc** is an open source Python package used to tune parameters for user-supplied functions based on the [Artificial Bee Colony by D. Karaboğa](http://scholarpedia.org/article/Artificial_bee_colony_algorithm). ECabc optimizes user supplied functions, or **fitness function**s, using a set of variables that exist within a search space. The bee colony consists of three types of bees: employers, onlookers and scouts. An **employer bee** exploits a solution comprised of a permutation of the variables in the search space, and evaluates the viability of the solution. An **onlooker bee** chooses an employer bee with an optimal solution and searches for new solutions near them. The **scout bee**, a variant of the employer bee, will search for a new solution if it has stayed too long at its current solution.
+
+<p align="center">
+  <img align="center" src="docs/img/abc_visual_convergence.gif" width="75%" height="75%">
+</p>
+
+### Research applications
+While it has several applications, ECabc has been successfully used by the Energy and Combustion Research Laboratory (ECRL) at the University of Massachusetts Lowell to tune the hyperparameters of ECNet, an open source Python package tailored to predicting fuel properties. ECNet provides scientists an open source tool for predicting key fuel properties of potential next-generation biofuels, reducing the need for costly fuel synthesis and experimentation. By increasing the accuracy of ECNet and similar models efficiently, ECabc helps to provide a higher degree of confidence in discovering new, optimal fuels. A single run of ECabc on ECNet yielded a lower average root mean square error (RMSE) for cetane number (CN) and yield sooting index (YSI) when compared to the RMSE generated by a year of manual tuning. While the manual tuning generated an RMSE of 10.13, the ECabc was able to yield an RMSE of 8.06 in one run of 500 iterations.
+
+# Installation
+
+**Requires Python 3.10 or newer.** ECabc has no runtime third-party dependencies
+(stdlib only). A virtual environment is recommended.
+
+### Method 1: pip
+
+```
+pip install ecabc
+```
+
+To upgrade to the latest release:
+
+```
+pip install --upgrade ecabc
+```
+
+### Method 2: From source
+
+Clone or download this repository, then from the repository root:
+
+```
+pip install .
+```
+
+# Usage
+
+API stability for the public surface is documented in
+[API_STABILITY.md](API_STABILITY.md) (also the Sphinx *API stability policy*
+page under `docs/source/stability.rst`).
+
+To start using ECabc, you need a couple items:
+- a fitness function (cost function) to optimize
+- parameters used by the fitness function
+
+For example, let's define a fitness function to minimize the sum of three integers:
+
+```python
+def minimize_integers(integers):
+
+    return sum(integers)
+
+```
+
+Your fitness function must accept a **list** from ECabc. The list values represent the current "food source", i.e. parameter values, being exploited by a given bee.
+
+Now that we have our fitness function, let's import the ABC object from ECabc, initialize the artificial bee colony, and add our parameters:
+
+```python
+from ecabc import ABC
+
+def minimize_integers(integers):
+
+    return sum(integers)
+
+abc = ABC(10, minimize_integers)
+abc.add_param(0, 10, name='Int_1')
+abc.add_param(0, 10, name='Int_2')
+abc.add_param(0, 10, name='Int_3')
+```
+
+Here we initialize the colony with 10 employer bees, supply our fitness function, and add our parameters. Parameters are added with minimum/maximum values for its search space and optionally a name. By default, parameter mutations (searching a neighboring food source) will not exceed the specified parameter bounds [min_val, max_val]; if this limitation is not desired, supply the "restrict=False" argument:
+
+```python
+abc.add_param(0, 10, restrict=False, name='Int_1')
+```
+
+Once we have created our colony and added our parameters, we then need to "initialize" the colony's bees:
+
+```python
+from ecabc import ABC
+
+def minimize_integers(integers):
+
+    return sum(integers)
+
+abc = ABC(10, minimize_integers)
+abc.add_param(0, 10, name='Int_1')
+abc.add_param(0, 10, name='Int_2')
+abc.add_param(0, 10, name='Int_3')
+abc.initialize()
+```
+
+Initializing the colony's bees deploys employer bees (in this example, 10 bees) to random food sources (random parameter values are generated), their fitness is evaluated (in this example, lowest sum is better), and onlooker bees (equal to the number of employers) are deployed proportionally to neighboring food sources of well-performing bees.
+
+We then send the colony through a predetermined of "search cycles":
+
+```python
+from ecabc import ABC
+
+def minimize_integers(integers):
+
+    return sum(integers)
+
+abc = ABC(10, minimize_integers)
+abc.add_param(0, 10, name='Int_1')
+abc.add_param(0, 10, name='Int_2')
+abc.add_param(0, 10, name='Int_3')
+abc.initialize()
+for _ in range(10):
+    abc.search()
+```
+
+A search cycle consists of:
+- each bee searches a neighboring food source (performs a mutation on one parameter)
+- if the food source produces a better fitness than the bee's current food source, move there
+- otherwise, the bee stays at its current food source
+    - if the bee has stayed for (NE * D) cycles (NE = number of employers, D = dimension of the function, 3 in our example), abandon the food source
+        - if the bee is an employer, go to a new random food source
+        - if the bee is an onlooker, go to a food source neighboring a well-performing bee
+
+We can access the colony's average fitness score, average fitness function return value, best fitness score, best fitness function return value and best parameters at any time:
+
+```python
+print(abc.average_fitness)
+print(abc.average_ret_val)
+print(abc.best_fitness)
+print(abc.best_ret_val)
+print(abc.best_params)
+```
+
+ECabc can utilize multiple CPU cores for concurrent processing:
+
+```python
+abc = ABC(10, minimize_integers, num_processes=8)
+```
+
+Tying everything together, we have:
+
+```python
+from ecabc import ABC
+
+def minimize_integers(integers):
+
+    return sum(integers)
+
+abc = ABC(10, minimize_integers)
+abc.add_param(0, 10, name='Int_1')
+abc.add_param(0, 10, name='Int_2')
+abc.add_param(0, 10, name='Int_3')
+abc.initialize()
+for _ in range(10):
+    abc.search()
+    print('Average fitness: {}'.format(abc.average_fitness))
+    print('Average obj. fn. return value: {}'.format(abc.average_ret_val))
+    print('Best fitness score: {}'.format(abc.best_fitness))
+    print('Best obj. fn. return value: {}'.format(abc.best_ret_val))
+    print('Best parameters: {}\n'.format(abc.best_params))
+```
+
+Running this script produces:
+
+```
+Average fitness: 0.08244866244866243
+Average obj. fn. return value: 11.65
+Best fitness score: 0.125
+Best obj. fn. return value: 7
+Best parameters: {'Int_1': 4, 'Int_2': 3, 'Int_3': 0}
+
+Average fitness: 0.0885855117105117
+Average obj. fn. return value: 10.8
+Best fitness score: 0.125
+Best obj. fn. return value: 7
+Best parameters: {'Int_1': 4, 'Int_2': 3, 'Int_3': 0}
+
+Average fitness: 0.10361832611832611
+Average obj. fn. return value: 9.4
+Best fitness score: 0.16666666666666666
+Best obj. fn. return value: 5
+Best parameters: {'Int_1': 2, 'Int_2': 3, 'Int_3': 0}
+
+Average fitness: 0.11173502151443326
+Average obj. fn. return value: 8.8
+Best fitness score: 0.2
+Best obj. fn. return value: 4
+Best parameters: {'Int_1': 0, 'Int_2': 0, 'Int_3': 4}
+
+Average fitness: 0.12448879551820731
+Average obj. fn. return value: 7.95
+Best fitness score: 0.2
+Best obj. fn. return value: 4
+Best parameters: {'Int_1': 1, 'Int_2': 3, 'Int_3': 0}
+
+Average fitness: 0.1767694805194805
+Average obj. fn. return value: 6.7
+Best fitness score: 1.0
+Best obj. fn. return value: 0
+Best parameters: {'Int_1': 0, 'Int_2': 0, 'Int_3': 0}
+
+Average fitness: 0.183255772005772
+Average obj. fn. return value: 6.3
+Best fitness score: 1.0
+Best obj. fn. return value: 0
+Best parameters: {'Int_1': 0, 'Int_2': 0, 'Int_3': 0}
+
+Average fitness: 0.20172799422799423
+Average obj. fn. return value: 5.65
+Best fitness score: 1.0
+Best obj. fn. return value: 0
+Best parameters: {'Int_1': 0, 'Int_2': 0, 'Int_3': 0}
+
+Average fitness: 0.23827561327561328
+Average obj. fn. return value: 4.95
+Best fitness score: 1.0
+Best obj. fn. return value: 0
+Best parameters: {'Int_1': 0, 'Int_2': 0, 'Int_3': 0}
+
+Average fitness: 0.28456349206349213
+Average obj. fn. return value: 4.35
+Best fitness score: 1.0
+Best obj. fn. return value: 0
+Best parameters: {'Int_1': 0, 'Int_2': 0, 'Int_3': 0}
+```
+
+To run this script yourself, head over to our [examples](https://github.com/ecrl/ecabc/tree/master/examples) directory.
+
+# Contributing, Reporting Issues and Other Support:
+
+To contribute to ECabc, make a pull request. Contributions should include tests for new features added, as well as extensive documentation.
+
+To report problems with the software or feature requests, file an issue. When reporting problems, include information such as error messages, your OS/environment and Python version.
+
+For additional support/questions, contact Sanskriti Sharma (Sanskriti_Sharma@student.uml.edu), Hernan Gelaf-Romer (Hernan_Gelafromer@student.uml.edu), or Travis Kessler (Travis_Kessler@student.uml.edu).