diff --git a/README.md b/README.md index 5c3f19f..31958e3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Procrustean SVD (proSVD) Tools for streaming dimension reduction analyses of neural data. +![alt text](lock-in.gif) + See `notebooks/` for usage. #### To build: @@ -10,27 +12,9 @@ $ cd streamingSVD $ pip install . ``` -#### TODO: -- check correctness of init with with some other basis - - use this to determine the alignment of some "hypothesis" subspace with the data? -- artefact rejection with online ICA (ORICA)? -- add input functions to pro.run() to run before (e.g. preprocessing) and after (e.g. project onto new subspace) each update -- do we care about W??? -- rename repo to proSVD - -#### datasets -- iEEG seizures -- EEG artefacts (TMS or eyeblink) -- monkey reaching (O'shea data, jPCA data) -- Neuropixels (Stringer, Musall) -- widefield/behavior? (both pretty large data) +#### To import: +``` +from proSVD.proSVD import proSVD +``` -#### methods -- online: - - Baker's seq-kl - - slow feature analysis - - ica - - jpca -- offline: - - SVD - - PSID? \ No newline at end of file +Under active development! Please contact pranjal.gupta@duke.edu for any inquiries. \ No newline at end of file diff --git a/lock-in.gif b/lock-in.gif new file mode 100644 index 0000000..27cf545 Binary files /dev/null and b/lock-in.gif differ