From 8d5c579c79743c7d1b9d24607edabf7675f433d3 Mon Sep 17 00:00:00 2001 From: Drew Herren Date: Fri, 13 Dec 2024 19:37:55 -0600 Subject: [PATCH] Updating documentation for the overhauled stochtree website --- cpp_docs/Doxyfile | 12 +++++++++--- stochtree/bart.py | 4 ++-- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/cpp_docs/Doxyfile b/cpp_docs/Doxyfile index 9c0d1708..366412c6 100644 --- a/cpp_docs/Doxyfile +++ b/cpp_docs/Doxyfile @@ -1039,7 +1039,13 @@ EXCLUDE = src/cpp11.cpp \ src/R_random_effects.cpp \ src/sampler.cpp \ src/serialization.cpp \ - src/stochtree_types.h + src/stochtree_types.h \ + include/stochtree/common.h \ + include/stochtree/export.h \ + include/stochtree/io.h \ + include/stochtree/log.h \ + include/stochtree/meta.h \ + include/stochtree/random.h # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded @@ -1075,7 +1081,7 @@ EXCLUDE_PATTERNS = */test/* \ # wildcard * is used, a substring. Examples: ANamespace, AClass, # ANamespace::AClass, ANamespace::*Test -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = StochTree::CommonC # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include @@ -1295,7 +1301,7 @@ GENERATE_HTML = NO # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_OUTPUT = html +HTML_OUTPUT = doxygen # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). diff --git a/stochtree/bart.py b/stochtree/bart.py index f4796f79..7f852142 100644 --- a/stochtree/bart.py +++ b/stochtree/bart.py @@ -505,7 +505,7 @@ def predict(self, covariates: np.array, basis: np.array = None) -> np.array: ---------- covariates : :obj:`np.array` Test set covariates. - basis_train : :obj:`np.array`, optional + basis : :obj:`np.array`, optional Optional test set basis vector, must be provided if the model was trained with a leaf regression basis. Returns @@ -562,7 +562,7 @@ def predict_mean(self, covariates: np.array, basis: np.array = None) -> np.array ---------- covariates : :obj:`np.array` Test set covariates. - basis_train : :obj:`np.array`, optional + basis : :obj:`np.array`, optional Optional test set basis vector, must be provided if the model was trained with a leaf regression basis. Returns