Skip to content

Commit f89e607

Browse files
committed
doc: README
1 parent 362c777 commit f89e607

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@
1919
[![Percentage of issues still open](http://isitmaintained.com/badge/open/firefly-cpp/FireflyAlgorithm.svg)](http://isitmaintained.com/project/firefly-cpp/FireflyAlgorithm "Percentage of issues still open")
2020
![GitHub contributors](https://img.shields.io/github/contributors/firefly-cpp/FireflyAlgorithm.svg)
2121

22-
## About
22+
## About 📋
2323

24-
This package implements a nature-inspired algorithm for optimization called Firefly Algorithm (FA) in Python programming language.
24+
This package implements a nature-inspired algorithm for optimization called Firefly Algorithm (FA) in Python programming language. 🌿🔍💻
2525

26-
## Installation:
26+
## Installation 📦
2727

2828
Install FireflyAlgorithm with pip:
2929
```sh
@@ -42,7 +42,7 @@ To install FireflyAlgorithm on Alpine Linux:
4242
$ apk add py3-fireflyalgorithm
4343
```
4444

45-
## Usage:
45+
## Usage 🚀
4646

4747
```python
4848
from fireflyalgorithm import FireflyAlgorithm
@@ -54,7 +54,7 @@ best = FA.run(function=sphere, dim=10, lb=-5, ub=5, max_evals=10000)
5454
print(best)
5555
```
5656

57-
### Test functions
57+
### Test functions 📈
5858

5959
In the `fireflyalgorithm.problems` module, you can find the implementations of 33 popular optimization test problems. Additionally, the module provides a utility function, `get_problem`, that allows you to retrieve a specific optimization problem function by providing its name as a string:
6060

@@ -65,12 +65,11 @@ from fireflyalgorithm.problems import get_problem
6565
rosenbrock = get_problem('rosenbrock')
6666
```
6767

68-
For more information about the implemented test functions, [click here](Problems.md)
68+
For more information about the implemented test functions, [click here](Problems.md).
6969

70-
### Command line interface
70+
### Command line interface 🖥️
7171

72-
The package also comes with a simple command line interface which allows you to evaluate the algorithm on several
73-
popular test functions
72+
The package also comes with a simple command line interface which allows you to evaluate the algorithm on several popular test functions. 🔬
7473

7574
```shell
7675
firefly-algorithm -h
@@ -100,10 +99,10 @@ options:
10099
--seed SEED Seed for the random number generator
101100
```
102101

103-
**Note:** The CLI script can also run as a python module (python -m niaarm ...)
102+
**Note:** The CLI script can also run as a python module (python -m niaarm ...).
104103

105104

106-
## Reference Papers:
105+
## Reference Papers 📚
107106

108107
I. Fister Jr., X.-S. Yang, I. Fister, J. Brest. [Memetic firefly algorithm for combinatorial optimization](http://www.iztok-jr-fister.eu/static/publications/44.pdf) in Bioinspired Optimization Methods and their Applications (BIOMA 2012), B. Filipic and J.Silc, Eds.
109108
Jozef Stefan Institute, Ljubljana, Slovenia, 2012

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy