lnccbrown / lnccbrown/ssm-simulators

Update hssm tutorial to use ssms.hssm_support

Open
#214 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

linear-ssm-simulators
Dominant language
Jupyter Notebook
Stars
24
Forks
18
Avg merge
1d 14h
Merged PRs (30d)
9

Description

> > Might make sense to add a tutorial on the `ssms` side that illustrates the usage of such an `hssm_ready` simulator?
>
> Are there tutorials for these functions in HSSM? If so, they could be moved over here as well. It feels like these features, at least at the moment, are _private_ to be used by within hssm only.

[Here's](https://lnccbrown.github.io/HSSM/tutorials/jax_callable_contribution_onnx_example/#decorate-and-wrap-a-simulator) an example of a tutorial that touches upon these topics.

_Originally posted by @AlexanderFengler in https://github.com/lnccbrown/ssm-simulators/issues/210#issuecomment-3303913133_

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked HSSM tutorial and search this repository for existing HSSM tutorials, `hssm_ready`, and `ssms.hssm_support`. Update the relevant tutorial so it demonstrates the `ssms.hssm_support` usage described in the issue and covers the related simulator workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.