wellton/braindecode
1
0
Fork 0
Código Issues Pull Requests Ações Pacotes Projetos Versões Wiki Atividade

new docs

Ver Código-Fonte
Esse commit está contido em:
Robin Tibor Schirrmeister
2018-09-17 17:41:20 +02:00
pai 1e3fcca4f8
commit 2d9059cec5
24 arquivos alterados com 215 adições e 143 exclusões
Baixar Arquivo de Patch Baixar Arquivo de Diff Expandir todos os arquivos Colapsar todos os arquivos
.buildinfo
+1 -1
Ver Arquivo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 17cc204c0ac58625e8848232a6ded51b
config: 832f1c3dea2d710628d6890dafbf90d6
tags: 645f666f9bcd5a90fca523b33c5a78b7
genindex.html
+15 -7
Ver Arquivo
@@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Index &mdash; Braindecode 0.4.3 documentation</title>
<title>Index &mdash; Braindecode 0.4.5 documentation</title>
@@ -36,7 +36,7 @@
<link rel="index" title="Index"
href="#"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="index.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -65,7 +65,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -365,10 +365,10 @@
</li>
<li><a href="source/braindecode.datautil.html#braindecode.datautil.splitters.concatenate_two_sets">concatenate_two_sets() (in module braindecode.datautil.splitters)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/braindecode.torch_ext.html#braindecode.torch_ext.util.confirm_gpu_availability">confirm_gpu_availability() (in module braindecode.torch_ext.util)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/braindecode.models.html#braindecode.models.eegnet.Conv2dWithConstraint">Conv2dWithConstraint (class in braindecode.models.eegnet)</a>
</li>
<li><a href="source/braindecode.html#braindecode.util.corr">corr() (in module braindecode.util)</a>
@@ -387,6 +387,8 @@
<li><a href="source/braindecode.models.html#braindecode.models.eegnet.EEGNetv4.create_network">(braindecode.models.eegnet.EEGNetv4 method)</a>
</li>
<li><a href="source/braindecode.models.html#braindecode.models.hybrid.HybridNet.create_network">(braindecode.models.hybrid.HybridNet method)</a>
</li>
<li><a href="source/braindecode.models.html#braindecode.models.hybrid.HybridNetModule.create_network">(braindecode.models.hybrid.HybridNetModule method)</a>
</li>
<li><a href="source/braindecode.models.html#braindecode.models.shallow_fbcsp.ShallowFBCSPNet.create_network">(braindecode.models.shallow_fbcsp.ShallowFBCSPNet method)</a>
</li>
@@ -472,7 +474,7 @@
<li><a href="source/braindecode.models.html#braindecode.models.eegnet.Conv2dWithConstraint.forward">forward() (braindecode.models.eegnet.Conv2dWithConstraint method)</a>
<ul>
<li><a href="source/braindecode.models.html#braindecode.models.hybrid.HybridNet.forward">(braindecode.models.hybrid.HybridNet method)</a>
<li><a href="source/braindecode.models.html#braindecode.models.hybrid.HybridNetModule.forward">(braindecode.models.hybrid.HybridNetModule method)</a>
</li>
<li><a href="source/braindecode.torch_ext.html#braindecode.torch_ext.modules.AvgPool2dWithConv.forward">(braindecode.torch_ext.modules.AvgPool2dWithConv method)</a>
</li>
@@ -528,6 +530,8 @@
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="source/braindecode.models.html#braindecode.models.hybrid.HybridNet">HybridNet (class in braindecode.models.hybrid)</a>
</li>
<li><a href="source/braindecode.models.html#braindecode.models.hybrid.HybridNetModule">HybridNetModule (class in braindecode.models.hybrid)</a>
</li>
</ul></td>
</tr></table>
@@ -754,6 +758,10 @@
<li><a href="source/braindecode.datautil.html#braindecode.datautil.signal_target.SignalAndTarget">SignalAndTarget (class in braindecode.datautil.signal_target)</a>
</li>
<li><a href="source/braindecode.visualization.html#braindecode.visualization.perturbation.spectral_perturbation_correlation">spectral_perturbation_correlation() (in module braindecode.visualization.perturbation)</a>
</li>
<li><a href="source/braindecode.datautil.html#braindecode.datautil.splitters.split_into_train_test">split_into_train_test() (in module braindecode.datautil.splitters)</a>
</li>
<li><a href="source/braindecode.datautil.html#braindecode.datautil.splitters.split_into_train_valid_test">split_into_train_valid_test() (in module braindecode.datautil.splitters)</a>
</li>
<li><a href="source/braindecode.datautil.html#braindecode.datautil.splitters.split_into_two_sets">split_into_two_sets() (in module braindecode.datautil.splitters)</a>
</li>
@@ -856,7 +864,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
index.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome to Braindecode &mdash; Braindecode 0.4.3 documentation</title>
<title>Welcome to Braindecode &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="#"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="#"/>
<link rel="next" title="Trialwise Decoding" href="notebooks/Trialwise_Decoding.html"/>
@@ -65,7 +65,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -339,7 +339,7 @@ For now focussed on convolutional networks.</p>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
notebooks/BBCI_Data.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Read and Decode BBCI Data &mdash; Braindecode 0.4.3 documentation</title>
<title>Read and Decode BBCI Data &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -64,7 +64,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -1083,7 +1083,7 @@ Epoched</a>.</p>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
notebooks/BBCI_Data_Start_Stop.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Read and Decode BBCI Data with Start-Stop-Markers &mdash; Braindecode 0.4.3 documentation</title>
<title>Read and Decode BBCI Data with Start-Stop-Markers &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -64,7 +64,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -1189,7 +1189,7 @@ runs, we cannot get much better :)</p>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
notebooks/BBCI_Data_Trialwise.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Read and Decode BBCI Data &mdash; Braindecode 0.4.3 documentation</title>
<title>Read and Decode BBCI Data &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -64,7 +64,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -981,7 +981,7 @@ Tutorial</a></div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
notebooks/Cropped_Decoding.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Cropped Decoding &mdash; Braindecode 0.4.3 documentation</title>
<title>Cropped Decoding &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<link rel="next" title="Trialwise Manual Training Loop" href="Trialwise_Manual_Training_Loop.html"/>
<link rel="prev" title="Trialwise Decoding" href="Trialwise_Decoding.html"/>
@@ -66,7 +66,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -1259,7 +1259,7 @@ and further described in:</p>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
notebooks/Cropped_Manual_Training_Loop.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Cropped Manual Training Loop &mdash; Braindecode 0.4.3 documentation</title>
<title>Cropped Manual Training Loop &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<link rel="next" title="Amplitude Perturbation Visualization" href="visualization/Perturbation.html"/>
<link rel="prev" title="Trialwise Manual Training Loop" href="Trialwise_Manual_Training_Loop.html"/>
@@ -66,7 +66,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -880,7 +880,7 @@ and further described in:</p>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
notebooks/Trialwise_Decoding.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Trialwise Decoding &mdash; Braindecode 0.4.3 documentation</title>
<title>Trialwise Decoding &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<link rel="next" title="Cropped Decoding" href="Cropped_Decoding.html"/>
<link rel="prev" title="Welcome to Braindecode" href="../index.html"/>
@@ -66,7 +66,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -1293,7 +1293,7 @@ and further described in:</p>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
notebooks/Trialwise_Manual_Training_Loop.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Trialwise Manual Training Loop &mdash; Braindecode 0.4.3 documentation</title>
<title>Trialwise Manual Training Loop &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<link rel="next" title="Cropped Manual Training Loop" href="Cropped_Manual_Training_Loop.html"/>
<link rel="prev" title="Cropped Decoding" href="Cropped_Decoding.html"/>
@@ -66,7 +66,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -956,7 +956,7 @@ and further described in:</p>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
notebooks/visualization/Perturbation.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Amplitude Perturbation Visualization &mdash; Braindecode 0.4.3 documentation</title>
<title>Amplitude Perturbation Visualization &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../../genindex.html"/>
<link rel="search" title="Search" href="../../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../../index.html"/>
<link rel="next" title="braindecode.datautil package" href="../../source/braindecode.datautil.html"/>
<link rel="prev" title="Cropped Manual Training Loop" href="../Cropped_Manual_Training_Loop.html"/>
@@ -66,7 +66,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -1158,7 +1158,7 @@ and further described in:</p>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
objects.inv
BIN
Ver Arquivo
Arquivo binário não exibido.
py-modindex.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Python Module Index &mdash; Braindecode 0.4.3 documentation</title>
<title>Python Module Index &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="index.html"/>
@@ -67,7 +67,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -430,7 +430,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
search.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Search &mdash; Braindecode 0.4.3 documentation</title>
<title>Search &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="#"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="index.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -64,7 +64,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -209,7 +209,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
searchindex.js
+1 -1
Ver Arquivo
Diff do arquivo suprimido porque uma ou mais linhas são muito longas
source/braindecode.datasets.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>braindecode.datasets package &mdash; Braindecode 0.4.3 documentation</title>
<title>braindecode.datasets package &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -64,7 +64,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -415,7 +415,7 @@ otherwise <code class="docutils literal"><span class="pre">None</span></code></p
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
source/braindecode.datautil.html
+62 -9
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>braindecode.datautil package &mdash; Braindecode 0.4.3 documentation</title>
<title>braindecode.datautil package &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<link rel="next" title="braindecode.experiments package" href="braindecode.experiments.html"/>
<link rel="prev" title="Amplitude Perturbation Visualization" href="../notebooks/visualization/Perturbation.html"/>
@@ -66,7 +66,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -586,7 +586,7 @@ see <a class="footnote-reference" href="#id2" id="id1">[1]</a>.</p>
<span id="braindecode-datautil-splitters-module"></span><h2>braindecode.datautil.splitters module<a class="headerlink" href="#module-braindecode.datautil.splitters" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="braindecode.datautil.splitters.concatenate_sets">
<code class="descclassname">braindecode.datautil.splitters.</code><code class="descname">concatenate_sets</code><span class="sig-paren">(</span><em>sets</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/datautil/splitters.py#L6-L21"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.datautil.splitters.concatenate_sets" title="Permalink to this definition"></a></dt>
<code class="descclassname">braindecode.datautil.splitters.</code><code class="descname">concatenate_sets</code><span class="sig-paren">(</span><em>sets</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/datautil/splitters.py#L7-L22"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.datautil.splitters.concatenate_sets" title="Permalink to this definition"></a></dt>
<dd><p>Concatenate all sets together.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@@ -604,7 +604,7 @@ see <a class="footnote-reference" href="#id2" id="id1">[1]</a>.</p>
<dl class="function">
<dt id="braindecode.datautil.splitters.concatenate_two_sets">
<code class="descclassname">braindecode.datautil.splitters.</code><code class="descname">concatenate_two_sets</code><span class="sig-paren">(</span><em>set_a</em>, <em>set_b</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/datautil/splitters.py#L24-L38"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.datautil.splitters.concatenate_two_sets" title="Permalink to this definition"></a></dt>
<code class="descclassname">braindecode.datautil.splitters.</code><code class="descname">concatenate_two_sets</code><span class="sig-paren">(</span><em>set_a</em>, <em>set_b</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/datautil/splitters.py#L25-L39"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.datautil.splitters.concatenate_two_sets" title="Permalink to this definition"></a></dt>
<dd><p>Concatenate two sets together.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@@ -622,12 +622,12 @@ see <a class="footnote-reference" href="#id2" id="id1">[1]</a>.</p>
<dl class="function">
<dt id="braindecode.datautil.splitters.concatenate_np_array_or_add_lists">
<code class="descclassname">braindecode.datautil.splitters.</code><code class="descname">concatenate_np_array_or_add_lists</code><span class="sig-paren">(</span><em>a</em>, <em>b</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/datautil/splitters.py#L40-L49"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.datautil.splitters.concatenate_np_array_or_add_lists" title="Permalink to this definition"></a></dt>
<code class="descclassname">braindecode.datautil.splitters.</code><code class="descname">concatenate_np_array_or_add_lists</code><span class="sig-paren">(</span><em>a</em>, <em>b</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/datautil/splitters.py#L41-L50"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.datautil.splitters.concatenate_np_array_or_add_lists" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="braindecode.datautil.splitters.split_into_two_sets">
<code class="descclassname">braindecode.datautil.splitters.</code><code class="descname">split_into_two_sets</code><span class="sig-paren">(</span><em>dataset</em>, <em>first_set_fraction=None</em>, <em>n_first_set=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/datautil/splitters.py#L53-L78"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.datautil.splitters.split_into_two_sets" title="Permalink to this definition"></a></dt>
<code class="descclassname">braindecode.datautil.splitters.</code><code class="descname">split_into_two_sets</code><span class="sig-paren">(</span><em>dataset</em>, <em>first_set_fraction=None</em>, <em>n_first_set=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/datautil/splitters.py#L54-L79"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.datautil.splitters.split_into_two_sets" title="Permalink to this definition"></a></dt>
<dd><p>Split set into two sets either by fraction of first set or by number
of trials in first set.</p>
<table class="docutils field-list" frame="void" rules="none">
@@ -653,7 +653,7 @@ of trials in first set.</p>
<dl class="function">
<dt id="braindecode.datautil.splitters.select_examples">
<code class="descclassname">braindecode.datautil.splitters.</code><code class="descname">select_examples</code><span class="sig-paren">(</span><em>dataset</em>, <em>indices</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/datautil/splitters.py#L81-L105"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.datautil.splitters.select_examples" title="Permalink to this definition"></a></dt>
<code class="descclassname">braindecode.datautil.splitters.</code><code class="descname">select_examples</code><span class="sig-paren">(</span><em>dataset</em>, <em>indices</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/datautil/splitters.py#L82-L106"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.datautil.splitters.select_examples" title="Permalink to this definition"></a></dt>
<dd><p>Select examples from dataset.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@@ -675,6 +675,59 @@ of trials in first set.</p>
</table>
</dd></dl>
<dl class="function">
<dt id="braindecode.datautil.splitters.split_into_train_valid_test">
<code class="descclassname">braindecode.datautil.splitters.</code><code class="descname">split_into_train_valid_test</code><span class="sig-paren">(</span><em>dataset</em>, <em>n_folds</em>, <em>i_test_fold</em>, <em>rng=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/datautil/splitters.py#L109-L151"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.datautil.splitters.split_into_train_valid_test" title="Permalink to this definition"></a></dt>
<dd><p>Split datasets into folds, select one valid fold, one test fold and merge rest as train fold.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>dataset</strong> (<a class="reference internal" href="#braindecode.datautil.signal_target.SignalAndTarget" title="braindecode.datautil.signal_target.SignalAndTarget"><code class="xref py py-class docutils literal"><span class="pre">SignalAndTarget</span></code></a>)</li>
<li><strong>n_folds</strong> (<em>int</em>) – Number of folds to split dataset into.</li>
<li><strong>i_test_fold</strong> (<em>int</em>) – Index of the test fold (0-based). Validation fold will be immediately preceding fold.</li>
<li><strong>rng</strong> (<cite>numpy.random.RandomState</cite>, optional) – Random Generator for shuffling, None means no shuffling</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>reduced_set</strong> – Dataset with only examples selected.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#braindecode.datautil.signal_target.SignalAndTarget" title="braindecode.datautil.signal_target.SignalAndTarget"><code class="xref py py-class docutils literal"><span class="pre">SignalAndTarget</span></code></a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="braindecode.datautil.splitters.split_into_train_test">
<code class="descclassname">braindecode.datautil.splitters.</code><code class="descname">split_into_train_test</code><span class="sig-paren">(</span><em>dataset</em>, <em>n_folds</em>, <em>i_test_fold</em>, <em>rng=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/datautil/splitters.py#L154-L190"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.datautil.splitters.split_into_train_test" title="Permalink to this definition"></a></dt>
<dd><blockquote>
<div>Split datasets into folds, select one test fold and merge rest as train fold.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>dataset</strong> (<a class="reference internal" href="#braindecode.datautil.signal_target.SignalAndTarget" title="braindecode.datautil.signal_target.SignalAndTarget"><code class="xref py py-class docutils literal"><span class="pre">SignalAndTarget</span></code></a>)</li>
<li><strong>n_folds</strong> (<em>int</em>) – Number of folds to split dataset into.</li>
<li><strong>i_test_fold</strong> (<em>int</em>) – Index of the test fold (0-based)</li>
<li><strong>rng</strong> (<cite>numpy.random.RandomState</cite>, optional) – Random Generator for shuffling, None means no shuffling</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>reduced_set</strong> – Dataset with only examples selected.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#braindecode.datautil.signal_target.SignalAndTarget" title="braindecode.datautil.signal_target.SignalAndTarget"><code class="xref py py-class docutils literal"><span class="pre">SignalAndTarget</span></code></a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="module-braindecode.datautil.trial_segment">
<span id="braindecode-datautil-trial-segment-module"></span><h2>braindecode.datautil.trial_segment module<a class="headerlink" href="#module-braindecode.datautil.trial_segment" title="Permalink to this headline"></a></h2>
@@ -930,7 +983,7 @@ start marker codes.</li>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
source/braindecode.experiments.html
+17 -18
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>braindecode.experiments package &mdash; Braindecode 0.4.3 documentation</title>
<title>braindecode.experiments package &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<link rel="next" title="braindecode.mne_ext package" href="braindecode.mne_ext.html"/>
<link rel="prev" title="braindecode.datautil package" href="braindecode.datautil.html"/>
@@ -66,7 +66,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -280,7 +280,7 @@ after best epoch from epochs dataframe.</p>
<dl class="class">
<dt id="braindecode.experiments.experiment.Experiment">
<em class="property">class </em><code class="descclassname">braindecode.experiments.experiment.</code><code class="descname">Experiment</code><span class="sig-paren">(</span><em>model</em>, <em>train_set</em>, <em>valid_set</em>, <em>test_set</em>, <em>iterator</em>, <em>loss_function</em>, <em>optimizer</em>, <em>model_constraint</em>, <em>monitors</em>, <em>stop_criterion</em>, <em>remember_best_column</em>, <em>run_after_early_stop</em>, <em>model_loss_function=None</em>, <em>batch_modifier=None</em>, <em>cuda=True</em>, <em>pin_memory=False</em>, <em>do_early_stop=True</em>, <em>reset_after_second_run=False</em>, <em>log_0_epoch=True</em>, <em>loggers=(‘print’</em>, <em>)</em>, <em>seed=2382938</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L86-L451"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">braindecode.experiments.experiment.</code><code class="descname">Experiment</code><span class="sig-paren">(</span><em>model</em>, <em>train_set</em>, <em>valid_set</em>, <em>test_set</em>, <em>iterator</em>, <em>loss_function</em>, <em>optimizer</em>, <em>model_constraint</em>, <em>monitors</em>, <em>stop_criterion</em>, <em>remember_best_column</em>, <em>run_after_early_stop</em>, <em>model_loss_function=None</em>, <em>batch_modifier=None</em>, <em>cuda=True</em>, <em>pin_memory=False</em>, <em>do_early_stop=True</em>, <em>reset_after_second_run=False</em>, <em>log_0_epoch=True</em>, <em>loggers=(‘print’</em>, <em>)</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L86-L446"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Class that performs one experiment on training, validation and test set.</p>
<p>It trains as follows:</p>
@@ -331,7 +331,6 @@ below or equal to the best train loss of first run.</li>
<li><strong>log_0_epoch</strong> (<em>bool</em>) – Whether to compute monitor values and log them before the
start of training.</li>
<li><strong>loggers</strong> (list of <a class="reference internal" href="#braindecode.experiments.loggers.Logger" title="braindecode.experiments.loggers.Logger"><code class="xref py py-class docutils literal"><span class="pre">Logger</span></code></a>) – How to show computed metrics.</li>
<li><strong>seed</strong> (<em>int</em>) – Random seed for python random module numpy.random and torch.</li>
</ul>
</td>
</tr>
@@ -342,27 +341,27 @@ start of training.</li>
</table>
<dl class="method">
<dt id="braindecode.experiments.experiment.Experiment.run">
<code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L205-L229"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.run" title="Permalink to this definition"></a></dt>
<code class="descname">run</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L201-L225"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.run" title="Permalink to this definition"></a></dt>
<dd><p>Run complete training.</p>
</dd></dl>
<dl class="method">
<dt id="braindecode.experiments.experiment.Experiment.setup_training">
<code class="descname">setup_training</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L231-L245"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.setup_training" title="Permalink to this definition"></a></dt>
<dd><p>Setup training, i.e. set random seeds, transform model to cuda,
<code class="descname">setup_training</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L227-L240"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.setup_training" title="Permalink to this definition"></a></dt>
<dd><p>Setup training, i.e. transform model to cuda,
initialize monitoring.</p>
</dd></dl>
<dl class="method">
<dt id="braindecode.experiments.experiment.Experiment.run_until_first_stop">
<code class="descname">run_until_first_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L247-L252"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.run_until_first_stop" title="Permalink to this definition"></a></dt>
<code class="descname">run_until_first_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L242-L247"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.run_until_first_stop" title="Permalink to this definition"></a></dt>
<dd><p>Run training and evaluation using only training set for training
until stop criterion is fulfilled.</p>
</dd></dl>
<dl class="method">
<dt id="braindecode.experiments.experiment.Experiment.run_until_second_stop">
<code class="descname">run_until_second_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L254-L267"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.run_until_second_stop" title="Permalink to this definition"></a></dt>
<code class="descname">run_until_second_stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L249-L262"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.run_until_second_stop" title="Permalink to this definition"></a></dt>
<dd><p>Run training and evaluation using combined training + validation set
for training.</p>
<p>Runs until loss on validation set decreases below loss on training set
@@ -372,7 +371,7 @@ first stop.</p>
<dl class="method">
<dt id="braindecode.experiments.experiment.Experiment.run_until_stop">
<code class="descname">run_until_stop</code><span class="sig-paren">(</span><em>datasets</em>, <em>remember_best</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L269-L291"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.run_until_stop" title="Permalink to this definition"></a></dt>
<code class="descname">run_until_stop</code><span class="sig-paren">(</span><em>datasets</em>, <em>remember_best</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L264-L286"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.run_until_stop" title="Permalink to this definition"></a></dt>
<dd><p>Run training and evaluation on given datasets until stop criterion is
fulfilled.</p>
<table class="docutils field-list" frame="void" rules="none">
@@ -392,7 +391,7 @@ fulfilled.</p>
<dl class="method">
<dt id="braindecode.experiments.experiment.Experiment.run_one_epoch">
<code class="descname">run_one_epoch</code><span class="sig-paren">(</span><em>datasets</em>, <em>remember_best</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L293-L323"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.run_one_epoch" title="Permalink to this definition"></a></dt>
<code class="descname">run_one_epoch</code><span class="sig-paren">(</span><em>datasets</em>, <em>remember_best</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L288-L318"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.run_one_epoch" title="Permalink to this definition"></a></dt>
<dd><p>Run training and evaluation on given datasets for one epoch.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@@ -411,7 +410,7 @@ fulfilled.</p>
<dl class="method">
<dt id="braindecode.experiments.experiment.Experiment.train_batch">
<code class="descname">train_batch</code><span class="sig-paren">(</span><em>inputs</em>, <em>targets</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L325-L348"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.train_batch" title="Permalink to this definition"></a></dt>
<code class="descname">train_batch</code><span class="sig-paren">(</span><em>inputs</em>, <em>targets</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L320-L343"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.train_batch" title="Permalink to this definition"></a></dt>
<dd><p>Train on given inputs and targets.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@@ -429,7 +428,7 @@ fulfilled.</p>
<dl class="method">
<dt id="braindecode.experiments.experiment.Experiment.eval_on_batch">
<code class="descname">eval_on_batch</code><span class="sig-paren">(</span><em>inputs</em>, <em>targets</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L350-L380"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.eval_on_batch" title="Permalink to this definition"></a></dt>
<code class="descname">eval_on_batch</code><span class="sig-paren">(</span><em>inputs</em>, <em>targets</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L345-L375"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.eval_on_batch" title="Permalink to this definition"></a></dt>
<dd><p>Evaluate given inputs and targets.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@@ -454,7 +453,7 @@ fulfilled.</p>
<dl class="method">
<dt id="braindecode.experiments.experiment.Experiment.monitor_epoch">
<code class="descname">monitor_epoch</code><span class="sig-paren">(</span><em>datasets</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L382-L427"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.monitor_epoch" title="Permalink to this definition"></a></dt>
<code class="descname">monitor_epoch</code><span class="sig-paren">(</span><em>datasets</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L377-L422"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.monitor_epoch" title="Permalink to this definition"></a></dt>
<dd><p>Evaluate one epoch for given datasets.</p>
<p>Stores results in <cite>epochs_df</cite></p>
<table class="docutils field-list" frame="void" rules="none">
@@ -470,13 +469,13 @@ fulfilled.</p>
<dl class="method">
<dt id="braindecode.experiments.experiment.Experiment.log_epoch">
<code class="descname">log_epoch</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L429-L434"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.log_epoch" title="Permalink to this definition"></a></dt>
<code class="descname">log_epoch</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L424-L429"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.log_epoch" title="Permalink to this definition"></a></dt>
<dd><p>Print monitoring values for this epoch.</p>
</dd></dl>
<dl class="method">
<dt id="braindecode.experiments.experiment.Experiment.setup_after_stop_training">
<code class="descname">setup_after_stop_training</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L436-L451"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.setup_after_stop_training" title="Permalink to this definition"></a></dt>
<code class="descname">setup_after_stop_training</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/experiments/experiment.py#L431-L446"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.experiments.experiment.Experiment.setup_after_stop_training" title="Permalink to this definition"></a></dt>
<dd><p>Setup training after first stop.</p>
<p>Resets parameters to best parameters and updates stop criterion.</p>
</dd></dl>
@@ -927,7 +926,7 @@ only 10% decreases count as a decrease and reset the counter.</li>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
source/braindecode.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>braindecode package &mdash; Braindecode 0.4.3 documentation</title>
<title>braindecode package &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -64,7 +64,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -454,7 +454,7 @@ precedence goes to key value pairs in latter dicts.
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
source/braindecode.mne_ext.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>braindecode.mne_ext package &mdash; Braindecode 0.4.3 documentation</title>
<title>braindecode.mne_ext package &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<link rel="next" title="braindecode.models package" href="braindecode.models.html"/>
<link rel="prev" title="braindecode.experiments package" href="braindecode.experiments.html"/>
@@ -66,7 +66,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -329,7 +329,7 @@ as the <code class="xref py py-func docutils literal"><span class="pre">concaten
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
source/braindecode.models.html
+42 -30
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>braindecode.models package &mdash; Braindecode 0.4.3 documentation</title>
<title>braindecode.models package &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<link rel="next" title="braindecode.torch_ext package" href="braindecode.torch_ext.html"/>
<link rel="prev" title="braindecode.mne_ext package" href="braindecode.mne_ext.html"/>
@@ -66,7 +66,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -220,22 +220,22 @@
<span id="braindecode-models-base-module"></span><h2>braindecode.models.base module<a class="headerlink" href="#module-braindecode.models.base" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="braindecode.models.base.find_optimizer">
<code class="descclassname">braindecode.models.base.</code><code class="descname">find_optimizer</code><span class="sig-paren">(</span><em>optimizer_name</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L20-L30"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.find_optimizer" title="Permalink to this definition"></a></dt>
<code class="descclassname">braindecode.models.base.</code><code class="descname">find_optimizer</code><span class="sig-paren">(</span><em>optimizer_name</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L23-L33"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.find_optimizer" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="braindecode.models.base.BaseModel">
<em class="property">class </em><code class="descclassname">braindecode.models.base.</code><code class="descname">BaseModel</code><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L33-L284"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.BaseModel" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">braindecode.models.base.</code><code class="descname">BaseModel</code><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L36-L296"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.BaseModel" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="braindecode.models.base.BaseModel.cuda">
<code class="descname">cuda</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L34-L41"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.BaseModel.cuda" title="Permalink to this definition"></a></dt>
<code class="descname">cuda</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L37-L44"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.BaseModel.cuda" title="Permalink to this definition"></a></dt>
<dd><p>Move underlying model to GPU.</p>
</dd></dl>
<dl class="method">
<dt id="braindecode.models.base.BaseModel.parameters">
<code class="descname">parameters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L43-L52"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.BaseModel.parameters" title="Permalink to this definition"></a></dt>
<code class="descname">parameters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L46-L55"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.BaseModel.parameters" title="Permalink to this definition"></a></dt>
<dd><p>Return parameters of underlying torch model.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@@ -251,7 +251,7 @@
<dl class="method">
<dt id="braindecode.models.base.BaseModel.compile">
<code class="descname">compile</code><span class="sig-paren">(</span><em>loss</em>, <em>optimizer</em>, <em>extra_monitors=None</em>, <em>cropped=False</em>, <em>iterator_seed=0</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L60-L92"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.BaseModel.compile" title="Permalink to this definition"></a></dt>
<code class="descname">compile</code><span class="sig-paren">(</span><em>loss</em>, <em>optimizer</em>, <em>extra_monitors=None</em>, <em>cropped=False</em>, <em>iterator_seed=0</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L63-L102"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.BaseModel.compile" title="Permalink to this definition"></a></dt>
<dd><p>Setup training for this model.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@@ -272,7 +272,7 @@
<dl class="method">
<dt id="braindecode.models.base.BaseModel.fit">
<code class="descname">fit</code><span class="sig-paren">(</span><em>train_X</em>, <em>train_y</em>, <em>epochs</em>, <em>batch_size</em>, <em>input_time_length=None</em>, <em>validation_data=None</em>, <em>model_constraint=None</em>, <em>remember_best_column=None</em>, <em>scheduler=None</em>, <em>log_0_epoch=True</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L94-L207"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.BaseModel.fit" title="Permalink to this definition"></a></dt>
<code class="descname">fit</code><span class="sig-paren">(</span><em>train_X</em>, <em>train_y</em>, <em>epochs</em>, <em>batch_size</em>, <em>input_time_length=None</em>, <em>validation_data=None</em>, <em>model_constraint=None</em>, <em>remember_best_column=None</em>, <em>scheduler=None</em>, <em>log_0_epoch=True</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L104-L219"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.BaseModel.fit" title="Permalink to this definition"></a></dt>
<dd><p>Fit the model using the given training data.</p>
<p>Will set <cite>epochs_df</cite> variable with a pandas dataframe to the history
of the training process.</p>
@@ -309,7 +309,7 @@ determines the best epoch.</li>
<dl class="method">
<dt id="braindecode.models.base.BaseModel.evaluate">
<code class="descname">evaluate</code><span class="sig-paren">(</span><em>X</em>, <em>y</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L209-L256"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.BaseModel.evaluate" title="Permalink to this definition"></a></dt>
<code class="descname">evaluate</code><span class="sig-paren">(</span><em>X</em>, <em>y</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L221-L268"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.BaseModel.evaluate" title="Permalink to this definition"></a></dt>
<dd><p>Evaluate, i.e., compute metrics on given inputs and targets.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@@ -333,7 +333,7 @@ determines the best epoch.</li>
<dl class="method">
<dt id="braindecode.models.base.BaseModel.predict">
<code class="descname">predict</code><span class="sig-paren">(</span><em>X</em>, <em>threshold_for_binary_case=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L258-L284"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.BaseModel.predict" title="Permalink to this definition"></a></dt>
<code class="descname">predict</code><span class="sig-paren">(</span><em>X</em>, <em>threshold_for_binary_case=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/base.py#L270-L296"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.base.BaseModel.predict" title="Permalink to this definition"></a></dt>
<dd><p>Predict the labels for given input data.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@@ -402,15 +402,15 @@ Human Brain Mapping , Aug. 2017. Online: <a class="reference external" href="htt
<dt id="braindecode.models.eegnet.EEGNetv4">
<em class="property">class </em><code class="descclassname">braindecode.models.eegnet.</code><code class="descname">EEGNetv4</code><span class="sig-paren">(</span><em>in_chans</em>, <em>n_classes</em>, <em>final_conv_length=’auto’</em>, <em>input_time_length=None</em>, <em>pool_mode=’mean’</em>, <em>F1=8</em>, <em>D=2</em>, <em>F2=16</em>, <em>kernel_length=64</em>, <em>third_kernel_size=(8</em>, <em>4)</em>, <em>drop_prob=0.25</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/eegnet.py#L22-L118"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.eegnet.EEGNetv4" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#braindecode.models.base.BaseModel" title="braindecode.models.base.BaseModel"><code class="xref py py-class docutils literal"><span class="pre">braindecode.models.base.BaseModel</span></code></a></p>
<p>EEGNet v4 model from <a class="reference internal" href="#id5" id="id3">[EEGNet]</a>.</p>
<p>EEGNet v4 model from <a class="reference internal" href="#eegnet4" id="id3">[EEGNet4]</a>.</p>
<p class="rubric">Notes</p>
<p>This implementation is not guaranteed to be correct, has not been checked
by original authors, only reimplemented from the paper description.</p>
<p class="rubric">References</p>
<table class="docutils citation" frame="void" id="eegnet" rules="none">
<table class="docutils citation" frame="void" id="eegnet4" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label">[EEGNet]</td><td>Lawhern, V. J., Solon, A. J., Waytowich, N. R., Gordon,
<tr><td class="label"><a class="fn-backref" href="#id3">[EEGNet4]</a></td><td>Lawhern, V. J., Solon, A. J., Waytowich, N. R., Gordon,
S. M., Hung, C. P., &amp; Lance, B. J. (2018).
EEGNet: A Compact Convolutional Network for EEG-based
Brain-Computer Interfaces.
@@ -428,15 +428,15 @@ arXiv preprint arXiv:1611.08024.</td></tr>
<dt id="braindecode.models.eegnet.EEGNet">
<em class="property">class </em><code class="descclassname">braindecode.models.eegnet.</code><code class="descname">EEGNet</code><span class="sig-paren">(</span><em>in_chans</em>, <em>n_classes</em>, <em>final_conv_length=’auto’</em>, <em>input_time_length=None</em>, <em>pool_mode=’max’</em>, <em>second_kernel_size=(2</em>, <em>32)</em>, <em>third_kernel_size=(8</em>, <em>4)</em>, <em>drop_prob=0.25</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/eegnet.py#L140-L236"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.eegnet.EEGNet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>EEGNet model from <a class="reference internal" href="#id5" id="id4">[EEGNet]</a>.</p>
<p>EEGNet model from <a class="reference internal" href="#eegnet" id="id4">[EEGNet]</a>.</p>
<p class="rubric">Notes</p>
<p>This implementation is not guaranteed to be correct, has not been checked
by original authors, only reimplemented from the paper description.</p>
<p class="rubric">References</p>
<table class="docutils citation" frame="void" id="id5" rules="none">
<table class="docutils citation" frame="void" id="eegnet" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label">[EEGNet]</td><td>Lawhern, V. J., Solon, A. J., Waytowich, N. R., Gordon,
<tr><td class="label"><a class="fn-backref" href="#id4">[EEGNet]</a></td><td>Lawhern, V. J., Solon, A. J., Waytowich, N. R., Gordon,
S. M., Hung, C. P., &amp; Lance, B. J. (2016).
EEGNet: A Compact Convolutional Network for EEG-based
Brain-Computer Interfaces.
@@ -455,15 +455,27 @@ arXiv preprint arXiv:1611.08024.</td></tr>
<span id="braindecode-models-hybrid-module"></span><h2>braindecode.models.hybrid module<a class="headerlink" href="#module-braindecode.models.hybrid" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="braindecode.models.hybrid.HybridNet">
<em class="property">class </em><code class="descclassname">braindecode.models.hybrid.</code><code class="descname">HybridNet</code><span class="sig-paren">(</span><em>n_chans</em>, <em>n_classes</em>, <em>input_time_length</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/hybrid.py#L11-L91"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.hybrid.HybridNet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">torch.nn.modules.module.Module</span></code>, <a class="reference internal" href="#braindecode.models.base.BaseModel" title="braindecode.models.base.BaseModel"><code class="xref py py-class docutils literal"><span class="pre">braindecode.models.base.BaseModel</span></code></a></p>
<p>Hybrid ConvNet model from <a class="footnote-reference" href="#id7" id="id6">[3]</a>.</p>
<em class="property">class </em><code class="descclassname">braindecode.models.hybrid.</code><code class="descname">HybridNet</code><span class="sig-paren">(</span><em>in_chans</em>, <em>n_classes</em>, <em>input_time_length</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/hybrid.py#L11-L25"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.hybrid.HybridNet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#braindecode.models.base.BaseModel" title="braindecode.models.base.BaseModel"><code class="xref py py-class docutils literal"><span class="pre">braindecode.models.base.BaseModel</span></code></a></p>
<p>Wrapper for HybridNetModule</p>
<dl class="method">
<dt id="braindecode.models.hybrid.HybridNet.create_network">
<code class="descname">create_network</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/hybrid.py#L20-L25"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.hybrid.HybridNet.create_network" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="braindecode.models.hybrid.HybridNetModule">
<em class="property">class </em><code class="descclassname">braindecode.models.hybrid.</code><code class="descname">HybridNetModule</code><span class="sig-paren">(</span><em>in_chans</em>, <em>n_classes</em>, <em>input_time_length</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/hybrid.py#L28-L108"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.hybrid.HybridNetModule" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">torch.nn.modules.module.Module</span></code></p>
<p>Hybrid ConvNet model from <a class="footnote-reference" href="#id6" id="id5">[3]</a>.</p>
<p>Very hardcoded at the moment.</p>
<p class="rubric">References</p>
<table class="docutils footnote" frame="void" id="id7" rules="none">
<table class="docutils footnote" frame="void" id="id6" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id6">[3]</a></td><td>Schirrmeister, R. T., Springenberg, J. T., Fiederer, L. D. J.,
<tr><td class="label"><a class="fn-backref" href="#id5">[3]</a></td><td>Schirrmeister, R. T., Springenberg, J. T., Fiederer, L. D. J.,
Glasstetter, M., Eggensperger, K., Tangermann, M., Hutter, F. &amp; Ball, T. (2017).
Deep learning with convolutional neural networks for EEG decoding and
visualization.
@@ -471,13 +483,13 @@ Human Brain Mapping , Aug. 2017. Online: <a class="reference external" href="htt
</tbody>
</table>
<dl class="method">
<dt id="braindecode.models.hybrid.HybridNet.create_network">
<code class="descname">create_network</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/hybrid.py#L71-L72"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.hybrid.HybridNet.create_network" title="Permalink to this definition"></a></dt>
<dt id="braindecode.models.hybrid.HybridNetModule.create_network">
<code class="descname">create_network</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/hybrid.py#L88-L89"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.hybrid.HybridNetModule.create_network" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="braindecode.models.hybrid.HybridNet.forward">
<code class="descname">forward</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/hybrid.py#L74-L91"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.hybrid.HybridNet.forward" title="Permalink to this definition"></a></dt>
<dt id="braindecode.models.hybrid.HybridNetModule.forward">
<code class="descname">forward</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/hybrid.py#L91-L108"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.hybrid.HybridNetModule.forward" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
@@ -489,12 +501,12 @@ Human Brain Mapping , Aug. 2017. Online: <a class="reference external" href="htt
<dt id="braindecode.models.shallow_fbcsp.ShallowFBCSPNet">
<em class="property">class </em><code class="descclassname">braindecode.models.shallow_fbcsp.</code><code class="descname">ShallowFBCSPNet</code><span class="sig-paren">(</span><em>in_chans</em>, <em>n_classes</em>, <em>input_time_length=None</em>, <em>n_filters_time=40</em>, <em>filter_time_length=25</em>, <em>n_filters_spat=40</em>, <em>pool_time_length=75</em>, <em>pool_time_stride=15</em>, <em>final_conv_length=30</em>, <em>conv_nonlin=&lt;function square&gt;</em>, <em>pool_mode=’mean’</em>, <em>pool_nonlin=&lt;function safe_log&gt;</em>, <em>split_first_layer=True</em>, <em>batch_norm=True</em>, <em>batch_norm_alpha=0.1</em>, <em>drop_prob=0.5</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/models/shallow_fbcsp.py#L11-L104"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.models.shallow_fbcsp.ShallowFBCSPNet" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#braindecode.models.base.BaseModel" title="braindecode.models.base.BaseModel"><code class="xref py py-class docutils literal"><span class="pre">braindecode.models.base.BaseModel</span></code></a></p>
<p>Shallow ConvNet model from <a class="footnote-reference" href="#id9" id="id8">[2]</a>.</p>
<p>Shallow ConvNet model from <a class="footnote-reference" href="#id8" id="id7">[2]</a>.</p>
<p class="rubric">References</p>
<table class="docutils footnote" frame="void" id="id9" rules="none">
<table class="docutils footnote" frame="void" id="id8" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id8">[2]</a></td><td>Schirrmeister, R. T., Springenberg, J. T., Fiederer, L. D. J.,
<tr><td class="label"><a class="fn-backref" href="#id7">[2]</a></td><td>Schirrmeister, R. T., Springenberg, J. T., Fiederer, L. D. J.,
Glasstetter, M., Eggensperger, K., Tangermann, M., Hutter, F. &amp; Ball, T. (2017).
Deep learning with convolutional neural networks for EEG decoding and
visualization.
@@ -583,7 +595,7 @@ backwards one layer.</p>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
source/braindecode.torch_ext.html
+5 -5
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>braindecode.torch_ext package &mdash; Braindecode 0.4.3 documentation</title>
<title>braindecode.torch_ext package &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<link rel="next" title="braindecode.visualization package" href="braindecode.visualization.html"/>
<link rel="prev" title="braindecode.models package" href="braindecode.models.html"/>
@@ -66,7 +66,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -439,7 +439,7 @@ forward() returns list of intermediate activations in a network during forward p
<dt id="braindecode.torch_ext.optimizers.AdamW">
<em class="property">class </em><code class="descclassname">braindecode.torch_ext.optimizers.</code><code class="descname">AdamW</code><span class="sig-paren">(</span><em>params</em>, <em>lr=0.001</em>, <em>betas=(0.9</em>, <em>0.999)</em>, <em>eps=1e-08</em>, <em>weight_decay=0</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/torch_ext/optimizers.py#L6-L77"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.torch_ext.optimizers.AdamW" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">torch.optim.optimizer.Optimizer</span></code></p>
<p>Implements Adam algorithm with fixed as TODO</p>
<p>Implements Adam algorithm with fixed as in <cite>AdamW</cite></p>
<p>It has been proposed in <a class="reference external" href="https://arxiv.org/abs/1412.6980">Adam: A Method for Stochastic Optimization</a>.</p>
<dl class="docutils">
<dt>Arguments:</dt>
@@ -630,7 +630,7 @@ array.</p>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
source/braindecode.visualization.html
+12 -12
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>braindecode.visualization package &mdash; Braindecode 0.4.3 documentation</title>
<title>braindecode.visualization package &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<link rel="prev" title="braindecode.torch_ext package" href="braindecode.torch_ext.html"/>
@@ -65,7 +65,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -364,7 +364,7 @@ Second dimension consists of Input x Filter(1) x H x W indeces. Can only handle
<span id="braindecode-visualization-perturbation-module"></span><h2>braindecode.visualization.perturbation module<a class="headerlink" href="#module-braindecode.visualization.perturbation" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="braindecode.visualization.perturbation.phase_perturbation">
<code class="descclassname">braindecode.visualization.perturbation.</code><code class="descname">phase_perturbation</code><span class="sig-paren">(</span><em>amps</em>, <em>phases</em>, <em>rng=&lt;mtrand.RandomState object&gt;</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/visualization/perturbation.py#L11-L45"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.visualization.perturbation.phase_perturbation" title="Permalink to this definition"></a></dt>
<code class="descclassname">braindecode.visualization.perturbation.</code><code class="descname">phase_perturbation</code><span class="sig-paren">(</span><em>amps</em>, <em>phases</em>, <em>rng=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/visualization/perturbation.py#L11-L47"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.visualization.perturbation.phase_perturbation" title="Permalink to this definition"></a></dt>
<dd><p>Takes amps and phases of BxCxF with B input, C channels, F frequencies
Shifts spectral phases randomly U(-pi,pi) for input and frequencies, but same for all channels</p>
<table class="docutils field-list" frame="void" rules="none">
@@ -374,7 +374,7 @@ Shifts spectral phases randomly U(-pi,pi) for input and frequencies, but same fo
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>amps</strong> (<em>numpy array</em>) – Spectral amplitude (not used)</li>
<li><strong>phases</strong> (<em>numpy array</em>) – Spectral phases</li>
<li><strong>rng</strong> (<em>object</em>) – Random Seed</li>
<li><strong>rng</strong> (<em>object</em>) – Random Generator</li>
</ul>
</td>
</tr>
@@ -392,7 +392,7 @@ Shifts spectral phases randomly U(-pi,pi) for input and frequencies, but same fo
<dl class="function">
<dt id="braindecode.visualization.perturbation.amp_perturbation_additive">
<code class="descclassname">braindecode.visualization.perturbation.</code><code class="descname">amp_perturbation_additive</code><span class="sig-paren">(</span><em>amps</em>, <em>phases</em>, <em>rng=&lt;mtrand.RandomState object&gt;</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/visualization/perturbation.py#L47-L73"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.visualization.perturbation.amp_perturbation_additive" title="Permalink to this definition"></a></dt>
<code class="descclassname">braindecode.visualization.perturbation.</code><code class="descname">amp_perturbation_additive</code><span class="sig-paren">(</span><em>amps</em>, <em>phases</em>, <em>rng=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/visualization/perturbation.py#L49-L77"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.visualization.perturbation.amp_perturbation_additive" title="Permalink to this definition"></a></dt>
<dd><p>Takes amplitudes and phases of BxCxF with B input, C channels, F frequencies
Adds additive noise N(0,0.02) to amplitudes</p>
<table class="docutils field-list" frame="void" rules="none">
@@ -420,7 +420,7 @@ Adds additive noise N(0,0.02) to amplitudes</p>
<dl class="function">
<dt id="braindecode.visualization.perturbation.amp_perturbation_multiplicative">
<code class="descclassname">braindecode.visualization.perturbation.</code><code class="descname">amp_perturbation_multiplicative</code><span class="sig-paren">(</span><em>amps</em>, <em>phases</em>, <em>rng=&lt;mtrand.RandomState object&gt;</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/visualization/perturbation.py#L75-L100"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.visualization.perturbation.amp_perturbation_multiplicative" title="Permalink to this definition"></a></dt>
<code class="descclassname">braindecode.visualization.perturbation.</code><code class="descname">amp_perturbation_multiplicative</code><span class="sig-paren">(</span><em>amps</em>, <em>phases</em>, <em>rng=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/visualization/perturbation.py#L79-L106"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.visualization.perturbation.amp_perturbation_multiplicative" title="Permalink to this definition"></a></dt>
<dd><p>Takes amplitude and phases of BxCxF with B input, C channels, F frequencies
Adds multiplicative noise N(1,0.02) to amplitudes</p>
<table class="docutils field-list" frame="void" rules="none">
@@ -448,7 +448,7 @@ Adds multiplicative noise N(1,0.02) to amplitudes</p>
<dl class="function">
<dt id="braindecode.visualization.perturbation.correlate_feature_maps">
<code class="descclassname">braindecode.visualization.perturbation.</code><code class="descname">correlate_feature_maps</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/visualization/perturbation.py#L102-L135"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.visualization.perturbation.correlate_feature_maps" title="Permalink to this definition"></a></dt>
<code class="descclassname">braindecode.visualization.perturbation.</code><code class="descname">correlate_feature_maps</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/visualization/perturbation.py#L108-L141"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.visualization.perturbation.correlate_feature_maps" title="Permalink to this definition"></a></dt>
<dd><p>Takes two activation matrices of the form Bx[F]xT where B is batch size, F number of filters (optional) and T time points
Returns correlations of the corresponding activations over T</p>
<table class="docutils field-list" frame="void" rules="none">
@@ -469,7 +469,7 @@ Returns correlations of the corresponding activations over T</p>
<dl class="function">
<dt id="braindecode.visualization.perturbation.mean_diff_feature_maps">
<code class="descclassname">braindecode.visualization.perturbation.</code><code class="descname">mean_diff_feature_maps</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/visualization/perturbation.py#L137-L153"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.visualization.perturbation.mean_diff_feature_maps" title="Permalink to this definition"></a></dt>
<code class="descclassname">braindecode.visualization.perturbation.</code><code class="descname">mean_diff_feature_maps</code><span class="sig-paren">(</span><em>x</em>, <em>y</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/visualization/perturbation.py#L143-L159"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.visualization.perturbation.mean_diff_feature_maps" title="Permalink to this definition"></a></dt>
<dd><p>Takes two activation matrices of the form BxFxT where B is batch size, F number of filters and T time points
Returns mean difference between feature map activations</p>
<table class="docutils field-list" frame="void" rules="none">
@@ -490,7 +490,7 @@ Returns mean difference between feature map activations</p>
<dl class="function">
<dt id="braindecode.visualization.perturbation.spectral_perturbation_correlation">
<code class="descclassname">braindecode.visualization.perturbation.</code><code class="descname">spectral_perturbation_correlation</code><span class="sig-paren">(</span><em>pert_fn</em>, <em>diff_fn</em>, <em>pred_fn</em>, <em>n_layers</em>, <em>inputs</em>, <em>n_iterations</em>, <em>batch_size=30</em>, <em>seed=(2017</em>, <em>7</em>, <em>10)</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/visualization/perturbation.py#L155-L241"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.visualization.perturbation.spectral_perturbation_correlation" title="Permalink to this definition"></a></dt>
<code class="descclassname">braindecode.visualization.perturbation.</code><code class="descname">spectral_perturbation_correlation</code><span class="sig-paren">(</span><em>pert_fn</em>, <em>diff_fn</em>, <em>pred_fn</em>, <em>n_layers</em>, <em>inputs</em>, <em>n_iterations</em>, <em>batch_size=30</em>, <em>seed=(2017</em>, <em>7</em>, <em>10)</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/visualization/perturbation.py#L161-L247"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.visualization.perturbation.spectral_perturbation_correlation" title="Permalink to this definition"></a></dt>
<dd><p>Calculates perturbation correlations for layers in network by perturbing either amplitudes or phases</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
@@ -522,7 +522,7 @@ L x CxFrxFi (Channels,Frequencies,Filters)</p>
<dl class="function">
<dt id="braindecode.visualization.perturbation.compute_amplitude_prediction_correlations">
<code class="descclassname">braindecode.visualization.perturbation.</code><code class="descname">compute_amplitude_prediction_correlations</code><span class="sig-paren">(</span><em>pred_fn</em>, <em>examples</em>, <em>n_iterations</em>, <em>perturb_fn=&lt;function amp_perturbation_additive&gt;</em>, <em>batch_size=30</em>, <em>seed=(2017</em>, <em>7</em>, <em>10)</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/visualization/perturbation.py#L244-L291"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.visualization.perturbation.compute_amplitude_prediction_correlations" title="Permalink to this definition"></a></dt>
<code class="descclassname">braindecode.visualization.perturbation.</code><code class="descname">compute_amplitude_prediction_correlations</code><span class="sig-paren">(</span><em>pred_fn</em>, <em>examples</em>, <em>n_iterations</em>, <em>perturb_fn=&lt;function amp_perturbation_additive&gt;</em>, <em>batch_size=30</em>, <em>seed=(2017</em>, <em>7</em>, <em>10)</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/robintibor/braindecode/blob/master/braindecode/visualization/perturbation.py#L250-L297"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#braindecode.visualization.perturbation.compute_amplitude_prediction_correlations" title="Permalink to this definition"></a></dt>
<dd><p>Perturb input amplitudes and compute correlation between amplitude
perturbations and prediction changes when pushing perturbed input through
the prediction function.</p>
@@ -720,7 +720,7 @@ Parameters are: Frequency,Amplitude,Phase,DCOffset</li>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
source/modules.html
+4 -4
Ver Arquivo
@@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>braindecode &mdash; Braindecode 0.4.3 documentation</title>
<title>braindecode &mdash; Braindecode 0.4.5 documentation</title>
@@ -35,7 +35,7 @@
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Braindecode 0.4.3 documentation" href="../index.html"/>
<link rel="top" title="Braindecode 0.4.5 documentation" href="../index.html"/>
<script src="../_static/js/modernizr.min.js"></script>
@@ -64,7 +64,7 @@
<div class="version">
0.4.3
0.4.5
</div>
@@ -312,7 +312,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.4.3',
VERSION:'0.4.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,