You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](http://isitmaintained.com/project/NiaOrg/NiaPy"Average time to resolve an issue")
20
-
[](http://isitmaintained.com/project/NiaOrg/NiaPy"Percentage of issues still open")
Nature-inspired algorithms are a very popular tool for solving optimization problems. Numerous variants of nature-inspired algorithms have been developed ([paper 1](https://arxiv.org/abs/1307.4186), [paper 2](https://www.mdpi.com/2076-3417/8/9/1521)) since the beginning of their era. To prove their versatility, those were tested in various domains on various applications, especially when they are hybridized, modified or adapted. However, implementation of nature-inspired algorithms is sometimes a difficult, complex and tedious task. In order to break this wall, NiaPy is intended for simple and quick use, without spending time for implementing algorithms from scratch.
[Click here](Algorithms.md) for the list of implemented algorithms.
99
140
100
-
# Problems
141
+
## 🧪 Problems
101
142
102
143
[Click here](Problems.md) for the list of implemented test problems.
103
144
104
-
# Usage
145
+
## 🚀 Usage
105
146
106
147
After installation, you can import NiaPy as any other Python module:
107
148
@@ -111,10 +152,9 @@ $ python
111
152
>>> niapy.__version__
112
153
```
113
154
114
-
115
155
Let's go through a basic and advanced example.
116
156
117
-
## Basic Example
157
+
###Basic Example
118
158
Let’s say, we want to try out PSO against the Pintér problem function. Firstly, we have to create new file, with name, for example *basic_example.py*. Then we have to import chosen algorithm from NiaPy, so we can use it. Afterwards we initialize ParticleSwarmAlgorithm class instance and run the algorithm. Given bellow is the complete source code of basic example.
119
159
120
160
```python
@@ -144,7 +184,7 @@ Given example can be run with *python basic_example.py* command and should give
144
184
0.06732518679742806
145
185
```
146
186
147
-
## Advanced Example
187
+
###Advanced Example
148
188
149
189
In this example we will show you how to implement a custom problem class and use it with any of
150
190
implemented algorithms. First let's create new file named advanced_example.py. As in the previous examples
@@ -204,56 +244,7 @@ For more usage examples please look at [examples](/examples) folder.
204
244
205
245
More advanced examples can also be found in the [NiaPy-examples repository](https://github.com/NiaOrg/NiaPy-examples).
206
246
207
-
208
-
209
-
# Cite us
210
-
211
-
Are you using NiaPy in your project or research? Please cite us!
212
-
213
-
## Plain format
214
-
215
-
```
216
-
Vrbančič, G., Brezočnik, L., Mlakar, U., Fister, D., & Fister Jr., I. (2018).
217
-
NiaPy: Python microframework for building nature-inspired algorithms.
218
-
Journal of Open Source Software, 3(23), 613\. <https://doi.org/10.21105/joss.00613>
219
-
```
220
-
221
-
## Bibtex format
222
-
223
-
```
224
-
@article{NiaPyJOSS2018,
225
-
author = {Vrban{\v{c}}i{\v{c}}, Grega and Brezo{\v{c}}nik, Lucija
226
-
and Mlakar, Uro{\v{s}} and Fister, Du{\v{s}}an and {Fister Jr.}, Iztok},
227
-
title = {{NiaPy: Python microframework for building nature-inspired algorithms}},
228
-
journal = {{Journal of Open Source Software}},
229
-
year = {2018},
230
-
volume = {3},
231
-
issue = {23},
232
-
issn = {2475-9066},
233
-
doi = {10.21105/joss.00613},
234
-
url = {https://doi.org/10.21105/joss.00613}
235
-
}
236
-
```
237
-
238
-
## RIS format
239
-
240
-
```
241
-
TY - JOUR
242
-
T1 - NiaPy: Python microframework for building nature-inspired algorithms
243
-
AU - Vrbančič, Grega
244
-
AU - Brezočnik, Lucija
245
-
AU - Mlakar, Uroš
246
-
AU - Fister, Dušan
247
-
AU - Fister Jr., Iztok
248
-
PY - 2018
249
-
JF - Journal of Open Source Software
250
-
VL - 3
251
-
IS - 23
252
-
DO - 10.21105/joss.00613
253
-
UR - http://joss.theoj.org/papers/10.21105/joss.00613
254
-
```
255
-
256
-
## Contributors ✨
247
+
## 🫂 Contributors
257
248
258
249
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
259
250
@@ -301,16 +292,63 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
301
292
302
293
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!
303
294
304
-
## Contributing
295
+
## 🙇 Contributing
305
296
306
297
We encourage you to contribute to NiaPy! Please check out the [Contributing to NiaPy guide](CONTRIBUTING.md) for guidelines about how to proceed.
307
298
308
299
Everyone interacting in NiaPy's codebases, issue trackers, chat rooms and mailing lists is expected to follow the NiaPy [code of conduct](CODE_OF_CONDUCT.md).
309
300
310
-
## Licence
301
+
## 🔑 License
311
302
312
303
This package is distributed under the MIT License. This license can be found online at <http://www.opensource.org/licenses/MIT>.
313
304
314
305
## Disclaimer
315
306
316
307
This framework is provided as-is, and there are no guarantees that it fits your purposes or that it is bug-free. Use it at your own risk!
308
+
309
+
## 📄 Cite us
310
+
311
+
Are you using NiaPy in your project or research? Please cite us!
312
+
313
+
### Plain format
314
+
315
+
```
316
+
Vrbančič, G., Brezočnik, L., Mlakar, U., Fister, D., & Fister Jr., I. (2018).
317
+
NiaPy: Python microframework for building nature-inspired algorithms.
318
+
Journal of Open Source Software, 3(23), 613\. <https://doi.org/10.21105/joss.00613>
319
+
```
320
+
321
+
### Bibtex format
322
+
323
+
```bibtex
324
+
@article{NiaPyJOSS2018,
325
+
author = {Vrban{\v{c}}i{\v{c}}, Grega and Brezo{\v{c}}nik, Lucija
326
+
and Mlakar, Uro{\v{s}} and Fister, Du{\v{s}}an and {Fister Jr.}, Iztok},
327
+
title = {{NiaPy: Python microframework for building nature-inspired algorithms}},
328
+
journal = {{Journal of Open Source Software}},
329
+
year = {2018},
330
+
volume = {3},
331
+
issue = {23},
332
+
issn = {2475-9066},
333
+
doi = {10.21105/joss.00613},
334
+
url = {https://doi.org/10.21105/joss.00613}
335
+
}
336
+
```
337
+
338
+
### RIS format
339
+
340
+
```
341
+
TY - JOUR
342
+
T1 - NiaPy: Python microframework for building nature-inspired algorithms
343
+
AU - Vrbančič, Grega
344
+
AU - Brezočnik, Lucija
345
+
AU - Mlakar, Uroš
346
+
AU - Fister, Dušan
347
+
AU - Fister Jr., Iztok
348
+
PY - 2018
349
+
JF - Journal of Open Source Software
350
+
VL - 3
351
+
IS - 23
352
+
DO - 10.21105/joss.00613
353
+
UR - http://joss.theoj.org/papers/10.21105/joss.00613
0 commit comments