aind-disrnn-utils 0.0.7

Generated from aind-library-template

aind_disrnn_utils

Usage

• Obtain a list of NWB files you wish to fit the model to

import aind_dynamic_foraging_multisession_analysis.multisession_load as ms_load
import aind_disrnn_utils as dl

nwbs, df_trials = ms_load.make_multisession_trials_df(nwb_files)
dataset = dl.create_disrnn_dataset(df_trials)

• You don't need to use make_multisession_trials_df, but the trials data frame does need to have a column "ses_idx" that splits trials into sessions.

Level of Support

• Occasional updates: We are planning on occasional updating this tool with no fixed schedule. Community involvement is encouraged through both issues and pull requests.

Installation

To install the software from PyPi

pip install aind-disrnn-utils

To use the software, in the root directory, run

pip install -e .

To develop the code, run

pip install -e . --group dev

Note: --group flag is available only in pip versions >=25.1

Alternatively, if using uv, run

uv sync

Required dependency

[!IMPORTANT]
PyPi does not allow "direct dependencies" where you install straight from github, therefore you must manually install the disentangled_rnn package

pip install git+https://github.com/google-deepmind/disentangled_rnns.git