Skip to content

Updating documentation for the overhauled stochtree website #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 14, 2024
Merged

Updating documentation for the overhauled stochtree website #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions cpp_docs/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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).
Expand Down
4 changes: 2 additions & 2 deletions stochtree/bart.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading