Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.2%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: mariolpantunes
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 317 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 15
Created over 4 years ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

README.md

pyBlindOpt

A library that implements several derivation-free optimization algorithms (such as genetic optimization). Currently, it implements six different algorithms: 1. Hill climbing is a mathematical optimization technique that belongs to the family of local search. It is an iterative algorithm that starts with an arbitrary solution to a problem and then attempts to find a better solution by making an incremental change to the solution. 2. Simulated annealing is a probabilistic technique for approximating the global optimum of a given function. Specifically, it is a metaheuristic to approximate global optimization in a large search space for an optimization problem. 3. Genetic algorithm is a metaheuristic inspired by the process of natural selection that belongs to the larger class of evolutionary algorithms (EA). Genetic algorithms are commonly used to generate high-quality solutions to optimization and search problems by relying on biologically inspired operators such as mutation, crossover, and selection. 4. Differential evolution is a method that optimizes a problem by iteratively trying to improve a candidate solution with regard to a given measure of quality. Such methods are commonly known as metaheuristics as they make few or no assumptions about the problem being optimized and can search very large spaces of candidate solutions. 5. Particle swarm optimization is a computational method that optimizes a problem by iteratively trying to improve a candidate solution with regard to a given measure of quality. It solves a problem by having a population of candidate solutions, here dubbed particles, and moving these particles around in the search space according to simple mathematical formula over the particle's position and velocity. Each particle's movement is influenced by its local best-known position but is also guided toward the best-known positions in the search space, which are updated as better positions are found by other particles. 6. Grey Wolf Optimization (GWO) is a population-based meta-heuristics algorithm that simulates the leadership hierarchy and hunting mechanism of grey wolves in nature.

All the algorithms take advantage of the joblib library to speed up the objective function and cache the results. The code was optimized to a certain degree but was made for teaching purposes. Please consider other libraries if you are looking for a stable implementation, such as pymoo. Regardless, any reported issues will be fixed as possible.

Installation

The library can be used by adding this line to the requirement.txt file:

bash git+https://github.com/mariolpantunes/pyBlindOpt@main#egg=pyBlindOpt

Or add the following line to the requirements.txt file:

bash pyBlindOpt>=0.1.3.5

Documentation

This library was documented using the google style docstring, it can be accessed here. Run the following commands to produce the documentation for this library.

bash pdoc --math -d google -o docs pyBlindOpt

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details

Status

Python CI

Owner

  • Name: Mário Antunes
  • Login: mariolpantunes
  • Kind: user
  • Location: Aveiro
  • Company: @ATNoG

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: optimization
message: >-
  A library that implements several derivation-free
  optimization algorithms (such as genetic
  optimization). The code was optimized to a certain
  degree but was made for teaching purposes.
type: software
authors:
  - given-names: Mário
    family-names: Antunes
    email: mario.antunes@av.it.pt
    affiliation: IT Aveiro
    orcid: 'https://orcid.org/0000-0002-6504-9441'

GitHub Events

Total
  • Release event: 9
  • Watch event: 2
  • Delete event: 1
  • Push event: 10
  • Create event: 8
Last Year
  • Release event: 9
  • Watch event: 2
  • Delete event: 1
  • Push event: 10
  • Create event: 8

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 69
  • Total Committers: 1
  • Avg Commits per committer: 69.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 16
  • Committers: 1
  • Avg Commits per committer: 16.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Mario Antunes m****s@g****m 69

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 2
  • Total pull requests: 0
  • Average time to close issues: 6 months
  • Average time to close pull requests: N/A
  • Total issue authors: 2
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Pmiguelmarques (1)
  • mariolpantunes (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 241 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 13
  • Total maintainers: 1
pypi.org: pyblindopt

A library that implements several derivation-free optimization algorithms (such as genetic optimization).

  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 241 Last month
Rankings
Dependent packages count: 7.4%
Average: 38.0%
Dependent repos count: 68.7%
Maintainers (1)
Last synced: 10 months ago

Dependencies

requirements.txt pypi
  • joblib >=1.1.0
  • numpy >=1.22.1
  • tqdm >=4.62.3
.github/workflows/main.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/publish.yml actions
  • actions/checkout v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
pyproject.toml pypi