Skip to content

Planner

Joshua Pickard edited this page Jul 28, 2024 · 2 revisions

The Planner module uses the following schema. This is a requirement of pipelines used by, read into, or generated from BRAD. This schema allows users to explicitly edit (or write) their own pipelines that can be added to the library.

{
    "name": "<name of the pipeline>",
    "description": "<description of the pipeline>.",
    "queue": {
        0: {
            "order": 0,
            "module": "PLANNER",
            "prompt": "none",
            "description": "the 0 key is a place holder that must exist but should never be executed. We can remove this from the schema but will need to edit planner.py",
            "next": [1]
        },
        1: {
            "order": <place in linear pipeline that it should execute>,
            "module": "<CODE, DATABASE, SCRAPE, etc.>",
            "prompt": "/force <module> <put a prompt here to use this module",
            "description": "<summary of this stage. This field is not used by BRAD and meant for leaving comments to the developers. >",
            "next": [<list of valid stages to run next>]
        },
        2: {
            "order": 2,
            "module": "CODE",
            "prompt": "/force CODE build a dynamics model of the 2015 gene coordinate time series data. Please select the appropriate parameters and inputs based on previous iterations.",
            "description": "This step builds models of the time series data that can be used for sensor selection.",
            "next": [3]
        },
        3: {
            ...
        }
        ...
    }
}
Clone this wiki locally