cavi_plvm: CAVI for the PLVM

View source: R/cavi_plvm.R

cavi_plvmR Documentation

CAVI for the PLVM

Description

Coordinate Ascent Variational Inference for the Phylogenetic Latent Variable Model

Usage

cavi_plvm(
  plvm_list,
  tol = 1e-06,
  max_iter = 1000,
  n_samples = 1000,
  random_seed = NULL,
  progress_bar = TRUE,
  perform_checks = TRUE
)

Arguments

plvm_list

A list defining the PLVM generated by 'initialise_plvm'.

tol

A positive real-valued scalar. The required reducting in the ELBO to define convergence,

max_iter

A positive integer. The maximum number of iterations that the optimisation procedure swill run.

n_samples

A positive integer. The number of samples drawn to esimated expected auxiliary trait values.

random_seed

The seed for random number generation.

progress_bar

Logical. Should a progress bar be displayed?

perform_checks

Logical. Check if function inputs are specified correctly.

Value

The optimised PLVM and ELBO at each iteration.

See Also

initialise_plvm


jpmeagher/vbar documentation built on Nov. 22, 2022, 5:48 a.m.