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

Minor docs #83

Closed
DominiqueMakowski opened this issue Jul 7, 2024 · 5 comments
Closed

Minor docs #83

DominiqueMakowski opened this issue Jul 7, 2024 · 5 comments

Comments

@DominiqueMakowski
Copy link
Contributor

image

There is also a typo in this function (extra "a").

Sorry I keep bumping you with these :)

@DominiqueMakowski
Copy link
Contributor Author

image

Another minor consistency suggestion for the title of the sections:

  • Single Choice Models
    • ExGaussian
    • Shifted LogNormal
    • Shifted Wald
    • Mixture Wald

Also regarding Mixture Wald, am I right in understanding that it is a generalization of the Shifted Wald and that Mixture Wald == Shifted Wald when η=0?

@itsdfish
Copy link
Owner

itsdfish commented Jul 7, 2024

No problem. These are all good suggestions.

Regarding your question about the Mixture Wald, you are correct.

@DominiqueMakowski
Copy link
Contributor Author

Regarding your question about the Mixture Wald, you are correct.

Wouldn't it make sense to "merge" the two constructors to streamline the user-facing API?
And internally use Wald when η=0 and MixtureWald when >0?
similarly to what the plan was in #29 for DDMs if I understood

@itsdfish
Copy link
Owner

itsdfish commented Jul 7, 2024

I think that is something worth considering in the future.

@DominiqueMakowski
Copy link
Contributor Author

Cool, I'll close this and will open a new issue to track that, so that I don't forget to update my docs if it's implemented

(the reason is that I am (once again) writing down my understanding of SSMs this time in a document for which I envision a larger scope: https://dominiquemakowski.github.io/CognitiveModels/4a_rt_descriptive.html

don't hesitate to let me know what you think and share any thoughts or ideas :) ) The way I see it, this "book" could be an add-on to this package where that could serve as a gentle general introduction to SSMs, from which people would then be able to make the most out of the more specific and technical examples of this package's documentation)

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

No branches or pull requests

2 participants