itsdfish / SequentialSamplingModels.jl

A unified interface for simulating and evaluating sequential sampling models in Julia.
https://itsdfish.github.io/SequentialSamplingModels.jl/dev/
MIT License
27 stars 4 forks source link

Minor docs #83

Closed DominiqueMakowski closed 2 months ago

DominiqueMakowski commented 2 months ago

image

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

Sorry I keep bumping you with these :)

DominiqueMakowski commented 2 months ago

image

Another minor consistency suggestion for the title of the sections:

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 commented 2 months ago

No problem. These are all good suggestions.

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

DominiqueMakowski commented 2 months ago

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 https://github.com/itsdfish/SequentialSamplingModels.jl/pull/29 for DDMs if I understood

itsdfish commented 2 months ago

I think that is something worth considering in the future.

DominiqueMakowski commented 2 months ago

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)