Skip to contents

Concepts & API Boundary

bayesgrove-concepts
Workflow review concepts
bg_api_boundary()
Query the bayesgrove API boundary

Research search (experimental)

bg_research_init()
Start a recorded model search
bg_research_state()
Read a recorded model search
bg_research_propose()
Propose an operation in a model search
bg_research_apply()
Apply a proposed research operation

Research rules (experimental)

bg_use_rules()
Install research rules
bg_rules()
Read the active research policy
bg_rule()
Define a research rule
bg_ruleset()
Define a ruleset
bg_ruleset_check()
Check a ruleset
bg_register_ruleset()
Register a ruleset for this session
bg_rulesets()
List available rulesets
bg_register_rule_predicate()
Register a custom rule predicate

Project Lifecycle

bg_handle()
bayesgrove Project Handle
bg_init()
Initialize a bayesgrove Project
bg_open()
Open a bayesgrove Project
bg_close()
Close a bayesgrove Project

Graph Construction

bg_add_node()
Add a node to the bayesgrove project graph
bg_connect()
Connect two nodes in the bayesgrove project graph
bg_update_node()
Update a node in the bayesgrove project graph
bg_remove_node()
Remove a node from the bayesgrove project graph
bg_set_node_data()
Attach a data object to a node via the content-addressed store
bg_read_graph()
Read project graph

Execution & Orchestration

bg_repl()
Interactive REPL for bayesgrove
bg_plan()
Create an execution plan
bg_run()
Run a project workflow
bg_jobs()
Read current state of all jobs
bg_compact_jobs()
Compact the append-only jobs log
bg_node_pad()
Read the provenance of a node's current artifact
bg_compute_fingerprint()
Compute the cache fingerprint for a node
bg_status()
Get workflow status
bg_result()
Retrieve a result artifact from the workflow
bg_pause()
Pause the workflow execution
bg_resume()
Resume the workflow execution
bg_snapshot()
Retrieve a complete snapshot of the project state
bg_bundle()
Bundle a bayesgrove project for reproducible handoff
bg_export_report()
Generate a reproducible markdown report of the workflow

Practitioner Shortcuts

bg_fit_stan()
Fit a Stan model in one call
bg_fit_brms()
Fit a brms model in one call

Visualization

bg_graph_mermaid()
Mermaid flowchart of the active project graph
bg_plot()
Plot a node's artifact or diagnostics

Workflow Protocol

bg_list_templates()
List built-in workflow templates
bg_use_default_workflow()
Activate the built-in starter workflow
bg_use_workflow_packs()
Activate workflow packs for a project
bg_workflow_packs()
List active workflow packs
bg_next_actions()
Compute deterministic next workflow actions
bg_execute_action()
Execute a workflow action
bg_extension_registry()
Return the descriptive extension registry for a project
bg_partition_protocol_by_scope()
Partition protocol results by scope
bg_build_workflow_context()
Build the workflow context for a given scope

Workflow State

bg_read_branch_registry()
Read the persisted branch registry
bg_read_goal_registry()
Read the persisted goal registry
bg_list_branches()
List all branches with their metadata
bg_branch_lineage()
Get the ancestor branch lineage for a branch
bg_scope_label()
Get a display label for a scope
bg_set_goal()
Set the active inferential goal for a branch
bg_get_goal()
Get the active inferential goal for a scope
bg_read_summaries()
Read persisted summaries
bg_write_summaries()
Persist executor summaries
bg_summary_vocabulary()
Built-in summary-kind vocabulary
bg_register_summary_kind()
Register a custom summary kind

Branching & Invalidation

bg_branch()
Branch a node in the bayesgrove project graph
bg_retire_node()
Retire a node and downstream lineage
bg_retire_branch()
Retire an entire branch
bg_invalidate()
Invalidate a node's result

Decisions & Gates

bg_add_gate()
Add a decision gate to an edge
bg_answer_gate()
Answer a decision gate
bg_pending_gates()
List pending decision gates
bg_repair_orphan_gates()
Remove orphan gates that cannot be answered or bypassed
bg_record_decision()
Record an explicit decision
bg_read_decisions()
Read the project decision log

Extensions

bg_register_node_kind()
Register a node kind in the bayesgrove runtime registry
bg_restore_executors()
Restore user-supplied executors from persisted source.
bg_use_cmdstanr()
Register cmdstanr node kinds on a project.
bg_use_brms()
Register brms node kinds on a project.
bg_hmc_severity()
Compute HMC diagnostic severity from sampler metrics.