Metadata-Version: 2.1
Name: abrain
Version: 1.0rc0.post5
Summary: NeuroEvolution in Python backed by C++ computations
Author-email: Kevin Godin-Dubois <k.j.m.godin-dubois@vu.nl>
Project-URL: Homepage, https://github.com/kgd-al/abrain
Project-URL: Documentation, https://abrain.rtfd.io
Project-URL: Bug Tracker, https://github.com/kgd-al/abrain/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Artificial Life
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: plotly
Requires-Dist: importlib-resources
Requires-Dist: graphviz
Requires-Dist: pyrecord
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-pyproject ; extra == 'docs'
Requires-Dist: sphinx-design ; extra == 'docs'
Requires-Dist: matplotlib ; extra == 'docs'
Requires-Dist: sphinx-copybutton ; extra == 'docs'
Requires-Dist: myst-parser ; extra == 'docs'
Requires-Dist: furo ; extra == 'docs'
Provides-Extra: kaleido
Requires-Dist: kaleido ; extra == 'kaleido'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pytest-steps ; extra == 'tests'
Requires-Dist: pytest-sugar ; extra == 'tests'
Requires-Dist: coverage ; extra == 'tests'
Requires-Dist: flake8 ; extra == 'tests'

# Artificial Brains (ABrain) for Python

C++/Python implementation of fully evolvable Artificial Neural Networks.
Uses the ES-HyperNEAT algorithms to *indirectly* encode ANNs with bio-mimetic
patterns (repetitions, symmetry...), large number of neurons and relative
robustness to input/output variations between generations.
The API is served in Python and computations are performed in C++.

[![Documentation Status](https://readthedocs.org/projects/abrain/badge/?version=latest)](https://abrain.readthedocs.io/en/latest/?badge=latest)
![PEP8](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/wiki/kgd-al/abrain/badge-flake.md)
[![PyPI version](https://badge.fury.io/py/abrain.svg)](https://badge.fury.io/py/abrain)
[![Downloads](https://static.pepy.tech/badge/abrain)](https://pepy.tech/project/abrain)

#### tested on latest
![](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/wiki/kgd-al/abrain/badge-wheel-manylinux.md)
![](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/wiki/kgd-al/abrain/badge-wheel-musllinux.md)
![](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/wiki/kgd-al/abrain/badge-wheel-macosx.md)
![](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/wiki/kgd-al/abrain/badge-wheel-win.md)

### Development
![](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/wiki/kgd-al/abrain/badge-version.md)
![](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/wiki/kgd-al/abrain/badge-tests.md)
![](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/wiki/kgd-al/abrain/badge-cov.md)
![](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/wiki/kgd-al/abrain/badge-pcov.md)
![](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/wiki/kgd-al/abrain/badge-ccov.md)

## Optional dependencies:

### Graphviz (dot)

To generate directed graphs for the genomes.
Can only be fetched by system installer (apt-get, yum, ...).
See https://graphviz.org/download/ for instructions

### Kaleido

To generate non-interactive images of ANN (through plotly).
Due to inconsistent support, left as an optional dependency.
Use `pip install abrain[...,kaleido]` to get it

## Todo list:
- [ ] Functionalities:
   - [ ] Order-independent ANN evaluation (with back buffer)?
   - [ ] Crossover / historical markings
     - [ ] Actually needed?
   - [ ] MANN Integration
     - [ ] Easy extraction
     - [ ] built-in testing
     - [ ] C++ wrapper
     - [ ] Visu
     
  - [ ] Misc:
    - [ ] Documentation
      - [ ] Advanced usage
      
      - [ ] move to scikit/poetry/... ?

  - [ ] CI/CD
    - [ ] Recent install gives `no loadimage plugion for "svg:cairo"` for pdf output
