Skip to content

Commit

Permalink
Updated documentation to account for new default model.
Browse files Browse the repository at this point in the history
  • Loading branch information
lucastheis committed Aug 2, 2015
1 parent ee5693d commit 410fe09
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
15 changes: 15 additions & 0 deletions README.md
Expand Up @@ -44,3 +44,18 @@ If you use our code in your research, please cite the following paper:
L. Theis, P. Berens, E. Froudarakis, J. Reimer, M. Roman-Roson, T. Baden, T. Euler, A. S. Tolias, et al.
[Supervised learning sets benchmark for robust spike detection from calcium imaging signals](http://bethgelab.org/publications/127/)
bioRxiv, 2014

The default model was trained on many datasets (together containing roughly 110,000 spikes) from
different labs. Therefore, if you use the default model for prediction, please also cite:

J. R. Cotton, E. Froudarakis, P. Storer, P. Saggau, and A. S. Tolias
Three-dimensional mapping of microcircuit correlation structure
Frontiers in Neural Circuits, 2013

J. Akerboom et al.
Optimization of a GCaMP calcium indicator for neural activity imaging
Journal of Neuroscience, 2012

T. W. Chen et al.
Ultrasensitive fluorescent proteins for imaging neuronal activity
Nature, 2013
7 changes: 4 additions & 3 deletions doc/scripts/tutorial.rst
Expand Up @@ -141,9 +141,9 @@ preprocessed yet, use
The predictions are saved in the same format as the data files, except that the entries
``spikes``, ``spike_times`` and ``calcium`` are removed to save space. By default, the prediction
uses a model which has been trained on data recorded from V1 of mice using OGB1 as indicator. But
it is possible to train a model which is better adapted to our data. Once trained, the model can be
used for prediction as follows:
uses a model which has been trained on several datasets recorded by different labs under different
conditions. These datasets combined contained roughly 110,000 spikes. But it is possible to train
a model specifically for our data. Once trained, the model can be used for prediction as follows:

.. code-block:: bash
Expand Down Expand Up @@ -171,6 +171,7 @@ To print a list of available parameters to influence the training, please see:
$ c2s train -h
Evaluation
----------

Expand Down

0 comments on commit 410fe09

Please sign in to comment.