Skip to content

Commit a11d215

Browse files
committed
fixing up, deployed to pip
1 parent da64af7 commit a11d215

19 files changed

Lines changed: 45 additions & 11 deletions

MANIFEST

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# file GENERATED by distutils, do NOT edit
2+
setup.cfg
3+
setup.py
4+
Solid/EvolutionaryAlgorithm.py
5+
Solid/GeneticAlgorithm.py
6+
Solid/HarmonySearch.py
7+
Solid/ParticleSwarm.py
8+
Solid/SimulatedAnnealing.py
9+
Solid/StochasticHillClimb.py
10+
Solid/TabuSearch.py
11+
Solid/__init__.py

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
# Metaheuristics-library-placeholder
1+
# Solid
2+
3+
## *Solid* is a simple library for gradient-free optimization.
4+
5+
#### It contains basic versions of many of the most common algorithms, and allows for very rapid development using them.
6+
7+
#### It's a very versatile library that's great for learning, modifying, and of course, using out-of-the-box.
8+
9+
<hr>
210

311
## Current Features:
412
* Genetic Algorithm
@@ -12,10 +20,10 @@
1220
<hr>
1321

1422
## Usage:
15-
* ```pip install```
23+
* ```pip install solidpy```
1624
* Import the relevant algorithm
1725
* Create a class that inherits from that algorithm, and that implements the necessary abstract methods
18-
* Call its ```.run()``` method
26+
* Call its ```.run()``` method, which always returns the best solution and its objective function value
1927

2028
<hr>
2129

@@ -24,7 +32,7 @@
2432
```python
2533
from random import choice, randint, random
2634
from string import lowercase
27-
from library.EvolutionaryAlgorithm import EvolutionaryAlgorithm
35+
from Solid import EvolutionaryAlgorithm
2836

2937

3038
class Algorithm(EvolutionaryAlgorithm):
File renamed without changes.

0 commit comments

Comments
 (0)