Skip to content

Commit

Permalink
add example section to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
jbytecode committed Aug 6, 2024
1 parent adf07e8 commit da01613
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,22 @@ pip install pycellga

Comprehensive documentation is available on the official documentation site.

## Example

Can we put a small code snipped here, for example finding the global minimum of Ackley function or something more interesting? It would also be nice to see more than one feature of the package with combining different algorithms and cases, e.g. different operators, byte-bit encodings, permutation, binary, or real, etc.

```python
# The function to be minimized
def f(x):
return (x[0] - 3.14159264)**2 + (x[1] - 2.71828)**2

result = optimizer(f, ....)

# The result is
# x[0] = 3.14159265
# x[1] = 2.71828
```

## Contributing

Contributions are welcome! Please read the contributing guidelines first.
Expand Down

0 comments on commit da01613

Please sign in to comment.