Skip to main content

FinchGE is a grammatical evolution library.

Project description

FinchGE: A Modular Grammatical Evolution Library

PyPI Python License Docs Status Tests

FinchGE is a modern, modular, and user-friendly Python library for Grammatical Evolution (GE) - a powerful evolutionary algorithm that uses formal grammars to evolve programs, expressions, and solutions.

Features

  • Define grammars using BNF-style syntax
  • Supports standard genetic operations: mutation, crossover, selection
  • Flexible fitness evaluation for any problem domain
  • Modular and extensible design allowing conveniently plugin custom Algorithms and Operators
  • Easy-to-read in-built logging and visualization
  • Intuitive API with extensive documentation and examples

Why finchGE

  • Modular and extensible: Plug-and-play mutation, election, fitness, and search strategies.
  • Designed for research and industry: Convenient and flexible API for quicker implementation.

Installation

# Basic installation
pip install finchge

# With optional dependencies
pip install finchge[pytorch]    # PyTorch support for using pytorch models (for HPO or NAS)
pip install finchge[all]        # All optional dependencies

Quick Example

Using finchGE is straightforward.

Step 1. Define grammar

grammar_file = "grammar.bnf"
grammar = Grammar.from_file(grammar_file)

Step 2. Define a Fitness Evaluator ; fitness_evaluator

fitness_evaluator = FitnessEvaluator(
    fitness_functions=StringMatchFitness("hello"),
    mapper=GenotypeMapper(grammar=grammar)
)

Step 3. Create GrammaticalEvolution instance and run

ge = GrammaticalEvolution(config=FinchConfig.default(),
                           grammar=grammar,
                           fitness_evaluator=fitness_evaluator)
ge.run()

For further details and more advanced usage, please check documentation at finchge.readthedocs.io, including Getting Started, API docReference and Examples

Development Status

Note: This is version 1.0.1-beta.7 - a beta release. Expect breaking changes and bugs.

What to expect:

  • Bugs and unexpected behavior
  • Rapid API changes
  • Frequent updates
  • Limited test coverage (improving daily)

Contributing

All contributions are welcome!

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Bug Reports and Feature Requests

Found a bug or have a feature request? Please open an issue on GitHub.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

finchge-1.0.1b7.tar.gz (124.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

finchge-1.0.1b7-py3-none-any.whl (159.6 kB view details)

Uploaded Python 3

File details

Details for the file finchge-1.0.1b7.tar.gz.

File metadata

  • Download URL: finchge-1.0.1b7.tar.gz
  • Upload date:
  • Size: 124.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for finchge-1.0.1b7.tar.gz
Algorithm Hash digest
SHA256 fb5c530691e1ec2aa4b388b0cb8e084bd71992667c054459e626c703ec561929
MD5 1c8eae1b24ebe32bd5abcd2a2380497e
BLAKE2b-256 c9eb765a9ce56bfb62000e5e339b19d45bf85fff500a488ec12458e0ed7f48a5

See more details on using hashes here.

File details

Details for the file finchge-1.0.1b7-py3-none-any.whl.

File metadata

  • Download URL: finchge-1.0.1b7-py3-none-any.whl
  • Upload date:
  • Size: 159.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for finchge-1.0.1b7-py3-none-any.whl
Algorithm Hash digest
SHA256 bf00f2f43bee34fdf6493faad1b4733e85320fce53acc8f0de10aadde030438b
MD5 63eefe98e30f6773883a3e4f29110bc5
BLAKE2b-256 01a9e9883b130884ee91648550feff26d56fcf9b6a4ef1ce5e4c265872092644

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page