Skip to content

Commit

Permalink
Update documentation to reflect changes in hssm version
Browse files Browse the repository at this point in the history
  • Loading branch information
digicosmos86 committed Jan 18, 2024
1 parent b17dd73 commit f1567f8
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 8 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ HSSM is a Python toolbox that provides a seamless combination of state-of-the-ar

## Installation

`hssm` is available through PyPI. You can install it with Pip via:
`hssm` is available through PyPI. You can install it with pip via:

```
pip install hssm
```

You can also install the bleeding edge version of `hssm` directly from this repo:
You can also install the bleeding-edge version of `hssm` directly from this repo:

```
pip install git+https://github.com/lnccbrown/HSSM.git
Expand All @@ -51,7 +51,7 @@ for more detailed instructions.
[here](https://github.com/lnccbrown/HSSM/discussions). We recommend leveraging an
environment manager with Python 3.10~3.11 to prevent any problems with dependencies
during the installation process. Please note that hssm is tested for python 3.10,
3.11. As of HSSM v0.1.6, support for Python 3.9 is dropped. Use other python
3.11. As of HSSM v0.2.0, support for Python 3.9 is dropped. Use other python
versions with caution.

## Example
Expand Down
6 changes: 2 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@

**HSSM** (Hierarchical Sequential Sampling Modeling) is a modern Python toolbox that provides state-of-the-art likelihood approximation methods within the Python Bayesian ecosystem. It facilitates hierarchical model building and inference via fast and robust MCMC samplers. User-friendly, extensible, and flexible, HSSM can rigorously estimate the impact of neural and other trial-by-trial covariates through parameter-wise mixed-effects models for a large variety of cognitive process models.


HSSM is a [BRAINSTORM](https://ccbs.carney.brown.edu/brainstorm) project in collaboration with the [Center for Computation and Visualization (CCV)](https://ccv.brown.edu/) and the [Center for Computational Brain Science](https://ccbs.carney.brown.edu/) within the [Carney Institute at Brown University](https://www.brown.edu/carney/).

## Features
Expand All @@ -30,7 +29,7 @@ HSSM is a [BRAINSTORM](https://ccbs.carney.brown.edu/brainstorm) project in coll

## Installation

`hssm` is available through PyPI. You can install it with Pip via:
`hssm` is available through PyPI. You can install it with pip via:

```bash
pip install hssm
Expand All @@ -50,10 +49,9 @@ For more detailed guidance, please check out our [installation guide](getting_st
[here](https://github.com/lnccbrown/HSSM/discussions). We recommend leveraging an
environment manager with Python 3.10~3.11 to prevent any problems with dependencies
during the installation process. Please note that hssm is tested for python 3.10,
3.11. As of HSSM v0.1.6, support for Python 3.9 is dropped. Use other python
3.11. As of HSSM v0.2.0, support for Python 3.9 is dropped. Use other python
versions with caution.


### Setting global float type

Using the analytical DDM (Drift Diffusion Model) likelihood in PyMC without forcing float type to `"float32"` in PyTensor may result in warning messages during sampling, which is a known bug in PyMC v5.6.0 and earlier versions. We can use `hssm.set_floatX("float32")` to get around this for now.
Expand Down
2 changes: 1 addition & 1 deletion docs/overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</span>
Navigate the site here!
</span>
<span class="right-margin"> v0.2.0b1 is released! </span>
<span class="right-margin"> v0.2.0 is released! </span>
<span>
<span class="twemoji">
{% include ".icons/material/head-question.svg" %}
Expand Down

0 comments on commit f1567f8

Please sign in to comment.