Getting Started

Integrate Gryffin into your project quickly!

Requirements

Python version >= 3.7

Installation

To install gryffin from PyPI:

$ pip install gryffin

To install gryffin from source:

$ git clone git@github.com:aspuru-guzik-group/gryffin.git
$ cd gryffin
$ pip install .

Example Usage

This is a minimalist example of Gryffin in action.

from gryffin import Gryffin
import experiment

# load config
config = {
    "parameters": [
        {"name": "param_0", "type": "continuous", "low": 0.0, "high": 1.0},
    ],
    objectives: [
        {"name": "obj", "goal": "min"},
    ]
}

# initialize gryffin
gryffin = Gryffin(
    config_dict=config
)

observations = []
for iter in range(ITER_BUDGET):

    # query gryffin for new params
    params  = gryffin.recommend(observations=observations)

    # evaluate the proposed parameters
    merit = experiment.run(params)
    params['obj'] = merit

    observations.append(params)