Skip to content

Improve getting started tutorial#634

Merged
cpaniaguam merged 4 commits intomainfrom
improve-getting-started-nb
Jan 27, 2025
Merged

Improve getting started tutorial#634
cpaniaguam merged 4 commits intomainfrom
improve-getting-started-nb

Conversation

@cpaniaguam
Copy link
Copy Markdown
Collaborator

Improve clarity; link related tutorials.

@cpaniaguam cpaniaguam self-assigned this Jan 21, 2025
Copy link
Copy Markdown
Member

@AlexanderFengler AlexanderFengler left a comment

Choose a reason for hiding this comment

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

leaving a small comment.
If this is the intended scope of the PR, then otherwise good to merge.

"HSSM has default specifications for the models above (such as response variables, likelihoods, choices, bounds, and others); no further specification is necessary.\n",
"\n",
"If `model` provided is not one of the above, then HSSM considers that you are using a custom model. We will cover custom models in more detail in a separate tutorial.\n",
"For custom type modeling, please use the `model` parameter of the HSSM class constructor (details in the [creating custom models](/docs/getting_started/hierarchical_modeling.ipynb) tutorial).\n",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

is this the right/intended tutorial that is linked here?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I think so (?). The original text says "We will cover custom models in more detail in a separate tutorial." I assumed that separate tutorial is the one in the /docs/getting_started/hierarchical_modeling.ipynb notebook. Is that correct?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@codecov
Copy link
Copy Markdown

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Copy link
Copy Markdown
Member

@AlexanderFengler AlexanderFengler left a comment

Choose a reason for hiding this comment

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

lgtm

@cpaniaguam cpaniaguam merged commit 2af8adc into main Jan 27, 2025
@digicosmos86 digicosmos86 deleted the improve-getting-started-nb branch February 10, 2026 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants