OnACID docs #1070
OnACID docs #1070
Conversation
|
|
||
| Ain: csc_matrix, optional | ||
| binary masked for seeded initialization as a Compressed Sparse Column matrix. | ||
| To use set ``"init_method"`` to ``"seeded"`` |
There was a problem hiding this comment.
I'm assuming this is the case
|
|
||
| Args: | ||
| params: CNMFParams | ||
| CNMFParams object with parameters for the entire run of initialization and OnACID |
There was a problem hiding this comment.
"for the entire run of" is weird phrasing
There was a problem hiding this comment.
"for the full pipeline: initialization -> motion correction -> source extraction"
| Estimates object to load an existing model | ||
|
|
||
| path: str, optional | ||
| path to a saved OnACID model on disk |
There was a problem hiding this comment.
should we mention what format the model is in? Or point at a doc maybe for how to make one of these?
There was a problem hiding this comment.
Pat good point., We should probably have an example of this in use in a demo notebook at some poin, given that we want to move toward online as the next gen.
There was a problem hiding this comment.
I assuming it's the hdf5 files? Anyways I think the better way to do this (and the estimates above) is to have a @classmethod. Such as OnACID.from_estimates(), OnACID.from_hdf(), etc.
| path to a saved OnACID model on disk | ||
|
|
||
| dview: | ||
| dview instance |
There was a problem hiding this comment.
I describe it as a "multicore processing object" and think that might be a good generic description?
It would be nice if we had better general documentation on dview (in the setup_cluster() the docs for it are "dview: ipyparallel dview object, or for multiprocessing: Pool object". But if the users use SLURM I'm not sure what dview will return. I think "multicore processing object" or something similar will work for all use cases?.
There was a problem hiding this comment.
yea the name dview isn't great and I myself am not sure exactly what this is in different scenarios, feel free to edit/suggest
|
let's merge this? OnACID is one of the least documented parts of the codebase and these will help. |
|
Once it's marked no-longer-WIP I'm happy to give it final review |
|
Ah right, edited, ready for another look! |
|
edited! 😄 |
adding some docstrings and comments to OnACID