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.6 - an 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.1b6.tar.gz (124.4 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.1b6-py3-none-any.whl (159.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: finchge-1.0.1b6.tar.gz
  • Upload date:
  • Size: 124.4 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.1b6.tar.gz
Algorithm Hash digest
SHA256 625a57ba592ca3e8e7e5f90b310576cb0b8a1871039a26739c6baa0ef18225af
MD5 93337ef101e2fa44f35acd4529283389
BLAKE2b-256 4723371aa7695edd998e51c4ddb7a1c57776fb4f20c0358095d0ff7f4327a7e2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: finchge-1.0.1b6-py3-none-any.whl
  • Upload date:
  • Size: 159.1 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.1b6-py3-none-any.whl
Algorithm Hash digest
SHA256 d84cec18b15c5e9bf97d42a71003dbd281e58309c31c547f327898a24a6fd178
MD5 473d137b2e65c787dade892ca00b6e12
BLAKE2b-256 a363740aaee3db8114c6995be2f29f27004f397c8e2edf711224f1239a0b1655

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