Merge pull request #273 from lnccbrown/272-update-documentation-for-h…

…ssm-v014 Updated documentation for v0.1.4
lnccbrown · Sep 6, 2023 · 706d167 · 706d167
2 parents 5a2724f + f2a4bcc
commit 706d167
Show file tree

Hide file tree

Showing 13 changed files with 4,503 additions and 5,124 deletions.
diff --git a/README.md b/README.md
@@ -94,11 +94,13 @@ HSSM is licensed under [Copyright 2023, Brown University, Providence, RI](LICENS
 
 ## Support
 
-For questions, bug reports, or other unexpected issues, please open an issue on the GitHub repository.
+For questions, please feel free to [open a discussion](https://github.com/lnccbrown/HSSM/discussions).
+
+For bug reports and feature requests, please feel free to [open an issue](https://github.com/lnccbrown/HSSM/issues) using the corresponding template.
 
 ## Contribution
 
-If you want to contribute to this project, please familiarize yourself with our [contribution guidelines](docs/CONTRIBUTING.md).
+If you want to contribute to this project, please follow our [contribution guidelines](docs/CONTRIBUTING.md).
 
 ## Acknowledgements
 

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -2,6 +2,15 @@
 
 ## 0.1.x
 
+### 0.1.4
+
+- Added support of `blackbox` likelihoods for `ddm` and `ddm_sdv` models.
+- Added support for `full_ddm` models via `blackbox` likelihoods.
+- Added the ability to use `hssm.Param` and `hssm.Prior` to specify model parameters.
+- Added support for non-parameter fields to be involved in the computation of likelihoods.
+- Major refactor of the code to improve readability and maintainability.
+- Fixed a bug in model.sample_posterior_predictive().
+
 ### 0.1.3
 
 - Added the ability to specify `inf`s in bounds.

diff --git a/docs/getting_started/getting_started.ipynb b/docs/getting_started/getting_started.ipynb
diff --git a/docs/index.md b/docs/index.md
@@ -11,13 +11,13 @@ HSSM is a Python toolbox that provides a seamless combination of state-of-the-ar
 
 **Contacts**: [email protected]
 
-**Github**: https://github.com/lnccbrown/HSSM
+**GitHub**: https://github.com/lnccbrown/HSSM
 
 **Copyright**: This document has been placed in the public domain.
 
 **License**: HSSM is licensed under [Copyright 2023, Brown University, Providence, RI](../LICENSE)
 
-**Version**: 0.1.3
+**Version**: 0.1.4
 
 - Allows approximate hierarchical Bayesian inference via various likelihood approximators.
 - Estimate impact of neural and other trial-by-trial covariates via native hierarchical mixed-regression support.
@@ -103,8 +103,10 @@ HSSM is licensed under [Copyright 2023, Brown University, Providence, RI](LICENS
 
 ## Support
 
-For questions, bug reports, or other unexpected issues, please open an issue on the GitHub repository.
+For questions, please feel free to [open a discussion](https://github.com/lnccbrown/HSSM/discussions).
+
+For bug reports and feature requests, please feel free to [open an issue](https://github.com/lnccbrown/HSSM/issues) using the corresponding template.
 
 ## Contributing
 
-If you want to contribute to this project, please familiarize yourself with our [contribution guidelines](CONTRIBUTING.md).
+If you want to contribute to this project, please follow our [contribution guidelines](CONTRIBUTING.md).
diff --git a/docs/overrides/main.html b/docs/overrides/main.html
@@ -7,13 +7,16 @@
     </span>
     Navigate the site here!
 </span>
+<span class="right-margin">
+    v0.1.4 is out!
+</span>
 <span>
     <span class="twemoji">
         {% include ".icons/material/head-question.svg" %}
     </span>
     Questions?
-    <a href="https://github.com/lnccbrown/HSSM/issues">
-        Open an issue here!
+    <a href="https://github.com/lnccbrown/HSSM/discussions">
+        Open a discussion here!
     </a>
 </span>
 {% endblock %}