{"id":15432829,"url":"https://github.com/gugarosa/opytimark","last_synced_at":"2025-04-19T17:46:38.497Z","repository":{"id":57449461,"uuid":"259632803","full_name":"gugarosa/opytimark","owner":"gugarosa","description":"📈 Opytimark is a Python library consisting of optimization benchmarking functions.","archived":false,"fork":false,"pushed_at":"2022-11-25T12:17:56.000Z","size":5740,"stargazers_count":8,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-18T07:40:15.257Z","etag":null,"topics":["benchmarking-functions","optimization","python"],"latest_commit_sha":null,"homepage":"https://opytimark.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gugarosa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-28T12:38:03.000Z","updated_at":"2024-01-17T21:16:24.000Z","dependencies_parsed_at":"2023-01-22T07:15:30.480Z","dependency_job_id":null,"html_url":"https://github.com/gugarosa/opytimark","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gugarosa%2Fopytimark","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gugarosa%2Fopytimark/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gugarosa%2Fopytimark/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gugarosa%2Fopytimark/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gugarosa","download_url":"https://codeload.github.com/gugarosa/opytimark/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249752143,"owners_count":21320449,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["benchmarking-functions","optimization","python"],"created_at":"2024-10-01T18:28:44.133Z","updated_at":"2025-04-19T17:46:38.288Z","avatar_url":"https://github.com/gugarosa.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Opytimark: Python Optimization Benchmarking Functions\n\n[![Latest release](https://img.shields.io/github/release/gugarosa/opytimark.svg)](https://github.com/gugarosa/opytimark/releases)\n[![Build status](https://img.shields.io/travis/com/gugarosa/opytimark/master.svg)](https://github.com/gugarosa/opytimark/releases)\n[![Open issues](https://img.shields.io/github/issues/gugarosa/opytimark.svg)](https://github.com/gugarosa/opytimark/issues)\n[![License](https://img.shields.io/github/license/gugarosa/opytimark.svg)](https://github.com/gugarosa/opytimark/blob/master/LICENSE)\n\n## Welcome to Opytimark.\nDid you ever need a set of pre-defined functions in order to test your optimization algorithm? Are you tired of implementing and validating by hand every function? If yes, Opytimark is the real deal! This package provides straightforward implementation of benchmarking functions for optimization tasks.\n\nUse Opytimark if you need a library or wish to:\n* Create your benchmarking function;\n* Design or use pre-loaded benchmarking functions;\n* Because it is overwhelming to evaluate things.\n\nRead the docs at [opytimark.readthedocs.io](https://opytimark.readthedocs.io).\n\nOpytimark is compatible with: **Python 3.6+**.\n\n---\n\n## Package guidelines\n\n1. The very first information you need is in the very **next** section.\n2. **Installing** is also easy if you wish to read the code and bump yourself into, follow along.\n3. Note that there might be some **additional** steps in order to use our solutions.\n4. If there is a problem, please do not **hesitate**, call us.\n\n---\n\n## Citation\n\nIf you use Opytimark to fulfill any of your needs, please cite us:\n\n```BibTex\n@misc{rosa2019opytimizer,\n    title={Opytimizer: A Nature-Inspired Python Optimizer},\n    author={Gustavo H. de Rosa and João P. Papa},\n    year={2019},\n    eprint={1912.13002},\n    archivePrefix={arXiv},\n    primaryClass={cs.NE}\n}\n```\n\n---\n\n## Getting started: 60 seconds with Opytimark\n\nFirst of all. We have examples. Yes, they are commented. Just browse to `examples/`, chose your subpackage, and follow the example. We have high-level examples for most tasks we could think.\n\nAlternatively, if you wish to learn even more, please take a minute:\n\nOpytimark is based on the following structure, and you should pay attention to its tree:\n\n```yaml\n- opytimark\n    - core\n        - benchmark\n        - cec_benchmark\n    - markers\n        - cec\n            - year_2005\n            - year_2008\n            - year_2010\n            - year_2013\n        - boolean\n        - one_dimensional\n        - two_dimensional\n        - many_dimensional\n        - n_dimensional\n    - utils\n        - constants\n        - decorator\n        - exception\n        - loader\n```\n\n### Core\n\nCore is the core. Essentially, it is the parent of everything. You should find parent classes defining the basis of our structure. They should provide variables and methods that will help to construct other modules.\n\n### Markers\n\nThis is why we are called Opytimark. This is the heart of the benchmarking functions, where you can find a large number of pre-defined functions. Investigate any module for more information.\n\n### Utils\n\nThis is a utility package. Common things shared across the application should be implemented here. It is better to implement once and use as you wish than re-implementing the same thing over and over again.\n\n---\n\n## Installation\n\nWe believe that everything has to be easy. Not tricky or daunting, Opytimark will be the one-to-go package that you will need, from the very first installation to the daily-tasks implementing needs. If you may just run the following under your most preferred Python environment (raw, conda, virtualenv, whatever):\n\n```bash\npip install opytimark\n```\n\nAlternatively, if you prefer to install the bleeding-edge version, please clone this repository and use:\n\n```bash\npip install -e .\n```\n\n---\n\n## Environment configuration\n\nNote that sometimes, there is a need for additional implementation. If needed, from here, you will be the one to know all of its details.\n\n### Ubuntu\n\nNo specific additional commands needed.\n\n### Windows\n\nNo specific additional commands needed.\n\n### MacOS\n\nNo specific additional commands needed.\n\n---\n\n## Support\n\nWe know that we do our best, but it is inevitable to acknowledge that we make mistakes. If you ever need to report a bug, report a problem, talk to us, please do so! We will be available at our bests at this repository.\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgugarosa%2Fopytimark","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgugarosa%2Fopytimark","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgugarosa%2Fopytimark/lists"}