Improve getting started tutorial #634
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| "\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", |
There was a problem hiding this comment.
is this the right/intended tutorial that is linked here?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
I think this https://lnccbrown.github.io/HSSM/tutorials/jax_callable_contribution_onnx_example/ and this https://lnccbrown.github.io/HSSM/tutorials/blackbox_contribution_onnx_example/ might work a bit better
Codecov ReportAll modified and coverable lines are covered by tests ✅ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improve clarity; link related tutorials.