Additional how-to guides #391
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
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
amageh
changed the title
kw_97_basic
Codecov Report
@@ Coverage Diff @@
## main #391 +/- ##
==========================================
+ Coverage 87.21% 87.38% +0.16%
==========================================
Files 50 50
Lines 3646 3638 -8
==========================================
- Hits 3180 3179 -1
+ Misses 466 459 -7
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
Co-authored-by: Annica Gehlen <ama.gehlen@gmail.com>
rafaelsuchy
reviewed
Dec 31, 2020
…mics/respy into add-filters-kw97
…mics/respy into add-filters-kw97
for more information, see https://pre-commit.ci
…mics/respy into add-filters-kw97
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.
Changes
I think this is needed to show users which example models are available. I have a similar description at the end of our respy tutorial/showcase here. Some open things I am considering:
Adding the plots for the choice patterns.
Adding more info on model characteristics like initial conditions etc.
Guide on model specification.
So far, the respy documentation is missing a comprehensive guide on model specification. I based this guide on #353 and a similar draft by @rafaelsuchy on the replication of kw_94. Let me know whether you think the guide is too detailed/ not detailed enough or if you think we should maybe split some stuff up (i.e. I thought about adding an extra guide for core state space filters and negative choice sets and removing some of the info in this one, if I remember correctly, Max is planning to write a guide on covariates at some point).
It would maybe be nice to add a reference guide similar to this on model specification components. I considered maybe writing separate ones on how
paramsandoptionsare processed internally in respy (although my ability to write very advanced guides like this may be limited but I could try :-) ).