Skip to content
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.

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

Added an entry in FAQ #874

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions docs/faq.qmd
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding a question about our interpret submodule. I think it is good.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I made another PR for adding interpret submodule question or this will work?

Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ It is a very powerful library, but can be challenging to use for beginners.
Bambi provides a simple interface for specifying models, and allows for easy inference via
MCMC or variational inference using PyMC.

## Why do the functions in the `interpret` submodule expect names of variables and not names of terms?

* In the interpret submodule, functions are designed to work with the names of variables directly rather than the names of terms. This approach simplifies the usage and avoids potential confusion.
For example, instead of passing bs(var_name, degree=3, knots=knots), you should pass var_name. The term bs(var_name, degree=3, knots=knots) represents a transformed version of the variable which includes additional details like degree and knots. However, the interpret functions are built to handle the raw variable names to maintain clarity and simplicity.

## Inference Questions

### What sampling methods are available?
Expand Down
1 change: 0 additions & 1 deletion examples
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why this was deleted?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That commit was made for some other issue, but as these commits were made in the same branch, it gets added here so i decided to delete it as it was creating a mess

This file was deleted.