Bingo's Documentation
=====================

Bingo is a flexible Python library for
symbolic regression via genetic programming.

.. toctree::
    :maxdepth: 1
    :caption: Contents:
    :hidden:

    installation
    get_started
    high_level
    low_level
    API Docs <_apidocs/modules>

.. panels::
    :card: + intro-card text-center bg-white
    :column: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex p-3
    :header: bg-white font-weight-bold
    :body: bg-white
    :footer: bg-white

    ---
    :img-top: _static/download_icon.svg
    :img-top-cls: w-25 align-center my-4

    Get Started
    ^^^

    Install Bingo and do a quick example.

    +++

    .. link-button:: get_started.html
        :text: To the Get Started Guide
        :classes: btn-block btn-primary

    ---
    :img-top: _static/running.svg
    :img-top-cls: w-25 align-center my-4

    High-Level Concepts
    ^^^

    Get an understanding of how Bingo works at a high level including
    basic concepts like symbolic regression, genetic programming etc.

    +++

    .. link-button:: high_level.html
        :text: To the High-Level User Guide
        :classes: btn-block btn-primary

    ---
    :img-top: _static/brackets.svg
    :img-top-cls: w-25 align-center my-4

    Low-Level Concepts
    ^^^

    Looking to develop your own components of GPSR or get an
    in-depth understand of Bingo's concepts? See the low-level user guide
    for detailed descriptions and examples of Bingo's concepts.

    +++

    .. link-button:: low_level.html
        :text: To the Low-Level User Guide
        :classes: btn-block btn-primary
    ---
    :img-top: _static/open_book.svg
    :img-top-cls: w-25 align-center my-4


    API Docs
    ^^^

    Descriptions of how to use Bingo's classes and methods including
    their inputs, outputs, etc.

    +++

    .. link-button:: _apidocs/modules.html
        :text: To the API Docs
        :classes: btn-block btn-primary