meegnet 0.1.1__tar.gz

meegnet-0.1.1/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

meegnet-0.1.1/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.1
+Name: meegnet
+Version: 0.1.1
+Summary: A set of MEG-optimized ANNs and visualization tools.
+Author: Arthur Dehgan
+License: MIT
+License-File: LICENSE.txt

meegnet-0.1.1/README.rst

@@ -0,0 +1,107 @@
+Welcome to MEEGNet!
+===================
+
+.. image:: https://img.shields.io/pypi/v/meegnet.svg
+   :target: https://pypi.org/project/meegnet/
+   
+.. image:: https://img.shields.io/pypi/pyversions/meegnet.svg
+   :target: https://pypi.org/project/meegnet/
+
+This is a suite of tools made available for neuroscience researchers to use a variety of M/EEG neural network architectures on their data.
+
+- **Source:** https://github.com/arthurdehgan/meegnet
+- **Bug Reports:** https://github.com/arthurdehgan/meegnet/issues
+
+
+MeegNet Architecture
+--------------------
+
+.. image:: https://github.com/arthurdehgan/meegnet/blob/master/architecture.png
+
+Other Available Architectures
+-----------------------------
+
+The package currently supports the following architectures: 
+
+* LF-CNN 
+* VAR-CNN 
+* EEGNet 
+
+Documentation
+=============
+
+For a full documentation of the package as well as tutorials on how to use the library, click the `Readthedocs <https://meegnet.readthedocs.io/en/latest/index.html>`_ link.
+
+Features
+========
+
+Work in Progress
+
+Tutorials
+=========
+
+Jupyter Notebook tutorials:
+---------------------------
+
+Prepare your data by following the instructions
+`here <https://github.com/arthurdehgan/meegnet/blob/master/notebooks/Prepare%20Data%20Tutorial.ipynb>`__
+
+Learn the basics of how to train and evaluate using a pre-made network
+`here <https://github.com/arthurdehgan/meegnet/blob/master/notebooks/Meegnet%20Network%20Training%20Basic%20Tutorial.ipynb>`__
+
+Alternatives
+============
+
+Maybe this package doesn’t suit your needs, in which case I can
+recommend similar packages with similar goals: 
+
+* https://mneflow.readthedocs.io/en/latest/
+* https://braindecode.org/stable/index.html
+
+References
+==========
+
+MEEGNet
+-------
+
+Work in Progress
+
+LF-CNN or VAR-CNN
+-----------------
+
+Zubarev I, Zetter R, Halme HL, Parkkonen L. Adaptive neural network
+classifier for decoding MEG signals. Neuroimage. 2019 May 4;197:425-434.
+`link <https://www.sciencedirect.com/science/article/pii/S1053811919303544?via%3Dihub>`__
+
+::
+
+   @article{Zubarev2019AdaptiveSignals.,
+       title = {{Adaptive neural network classifier for decoding MEG signals.}},
+       year = {2019},
+       journal = {NeuroImage},
+       author = {Zubarev, Ivan and Zetter, Rasmus and Halme, Hanna-Leena and Parkkonen, Lauri},
+       month = {5},
+       pages = {425--434},
+       volume = {197},
+       url = {https://linkinghub.elsevier.com/retrieve/pii/S1053811919303544 http://www.ncbi.nlm.nih.gov/pubmed/31059799},
+       doi = {10.1016/j.neuroimage.2019.04.068},
+       issn = {1095-9572},
+       pmid = {31059799},
+       keywords = {Brain–computer interface, Convolutional neural network, Magnetoencephalography}
+   }
+
+EEGNet
+------
+
+::
+
+   @article{Lawhern2018,
+     author={Vernon J Lawhern and Amelia J Solon and Nicholas R Waytowich and Stephen M Gordon and Chou P Hung and Brent J Lance},
+     title={EEGNet: a compact convolutional neural network for EEG-based brain–computer interfaces},
+     journal={Journal of Neural Engineering},
+     volume={15},
+     number={5},
+     pages={056013},
+     url={http://stacks.iop.org/1741-2552/15/i=5/a=056013},
+     year={2018}
+   }