This repository was archived by the owner on Jun 13, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsupported.html
More file actions
399 lines (384 loc) · 33.4 KB
/
supported.html
File metadata and controls
399 lines (384 loc) · 33.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
<!DOCTYPE html>
<html class="writer-html5" lang="Python" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Supported Functionality — ECGAN 1.0.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Preprocessing" href="preprocessing.html" />
<link rel="prev" title="ECGAN Structure" href="structure.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> ECGAN
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="get_started.html">Get started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="get_started.html#setup-and-first-steps">Setup and first steps</a></li>
<li class="toctree-l2"><a class="reference internal" href="get_started.html#setting-up-tracking-w-b">Setting up tracking (W&B)</a></li>
<li class="toctree-l2"><a class="reference internal" href="get_started.html#setting-up-kaggle-optional">Setting up kaggle [Optional]</a></li>
<li class="toctree-l2"><a class="reference internal" href="get_started.html#setting-up-s3-boto">Setting up S3/BOTO</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="structure.html">Framework Structure</a><ul>
<li class="toctree-l2"><a class="reference internal" href="structure.html#general-overview">General overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="structure.html#run-models-using-the-cli">Run models using the CLI</a></li>
<li class="toctree-l2"><a class="reference internal" href="structure.html#managing-the-workflow">Managing the workflow</a></li>
<li class="toctree-l2"><a class="reference internal" href="structure.html#implement-your-own-usecase">Implement Your Own Usecase</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Supported Methods and Datasets</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#supported-datasets">Supported Datasets</a></li>
<li class="toctree-l2"><a class="reference internal" href="#supported-preprocessing">Supported Preprocessing</a></li>
<li class="toctree-l2"><a class="reference internal" href="#supported-training">Supported Training</a></li>
<li class="toctree-l2"><a class="reference internal" href="#supported-models">Supported Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="#supported-trackers">Supported trackers</a></li>
<li class="toctree-l2"><a class="reference internal" href="#further-downstream-tasks">Further downstream tasks</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="preprocessing.html">Preprocessing</a></li>
<li class="toctree-l1"><a class="reference internal" href="synthesis.html">Data Synthesis</a></li>
<li class="toctree-l1"><a class="reference internal" href="anomaly_detection.html">Anomaly Detection</a><ul>
<li class="toctree-l2"><a class="reference internal" href="anomaly_detection.html#anogan">AnoGAN</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api/index.html">Python API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/cli.html">CLI</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/manager.html">Manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/config/index.html">Config</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/config/dataclasses.html">Custom Dataclasses</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/config/global_configs.html">Global configuration</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/config/initialization.html">Config initializations</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/config/nested_dataclasses.html">Nested Dataclasses</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/preprocessing/index.html">Preprocessing</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/preprocessing/cleansing.html">Cleansing</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/preprocessing/data_retrieval.html">Data Retrieval</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/preprocessing/preprocessor.html">Preprocessor</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/preprocessing/sampling.html">Sampling</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/training/index.html">Training</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/training/datasets.html">Dataset Structures</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/training/trainer.html">Trainer</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/modules/index.html">Modules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/modules/basemodule.html">Base Module</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/modules/generative/index.html">Generative Modules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/modules/generative/aegan.html">Autoencoder GAN</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/modules/generative/base.html">Generative Base Modules</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/modules/generative/dcgan.html">DCGAN</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/modules/generative/ecgan.html">Recurrent DCGAN</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/modules/generative/rgan.html">RGAN</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/modules/generative/vaegan.html">VAEGAN</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/modules/classifiers/index.html">Classification Modules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/modules/classifiers/base.html">Base classifier</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/modules/classifiers/nn_classifier.html">NN Classifier</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/modules/inverse_mapping/index.html">Inverse Mappings</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/modules/inverse_mapping/inverse_mapping.html">Inverse Mapping</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/modules/inverse_mapping/inversion.html">Base Inverse Mapping</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/modules/inverse_mapping/vanilla_inverse_mapping.html">Simple Inverse Mapping</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/networks/index.html">Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/anomaly_detection/index.html">Anomaly Detection</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/anomaly_detection/anomaly_assessment.html">Anomaly Assessment</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/anomaly_detection/anomaly_manager.html">Anomaly Manager</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/anomaly_detection/embedder.html">Embedders</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/anomaly_detection/reconstruction.html">Reconstruction</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/anomaly_detection/detector/index.html">Detectors</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/anomaly_detection/detector/base_detector.html">Base Detector</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/anomaly_detection/detector/classification_detector.html">Classification Detector</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/anomaly_detection/detector/detector_factory.html">Detector Factory</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/anomaly_detection/detector/reconstruction_detector.html">Reconstruction Detector</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/evaluation/index.html">Evaluation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/evaluation/metrics.html">Metrics</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/evaluation/optimization.html">Optimization</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/evaluation/tracker.html">Tracker</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/visualization/index.html">Visualization</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/visualization/evaluation.html">Evaluation visualization</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/visualization/plotter.html">Plotter</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api/utils/index.html">Utils</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api/utils/artifacts.html">Tracking artifacts</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/configurable.html">Configurable</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/custom_types.html">Custom Types</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/datasets.html">Datasets</a><ul>
<li class="toctree-l4"><a class="reference internal" href="api/utils/datasets.html#role-in-the-ecgan-pipeline">Role in the ECGAN Pipeline</a></li>
<li class="toctree-l4"><a class="reference internal" href="api/utils/datasets.html#adding-new-datasets">Adding new Datasets</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/distances.html">Distances</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/distributions.html">Custom distributions</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/embeddings.html">Embeddings</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/interpolation.html">Interpolation</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/label.html">Label</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/layers.html">Layers</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/log.html">Logging</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/losses.html">Loss functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/miscellaneous.html">Miscellaneous</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/optimizer.html">Optimizer</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/parser.html">Parser options for the CLI commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/plotting.html">Plotting helpers</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/reconstruction_criteria.html">Reconstruction Criteria</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/sampler.html">Sampler</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/splitting.html">Splitting</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/timer.html">Timer</a></li>
<li class="toctree-l3"><a class="reference internal" href="api/utils/transformation.html">Transformation</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a><ul>
<li class="toctree-l2"><a class="reference internal" href="references.html#related-work">Related Work</a><ul>
<li class="toctree-l3"><a class="reference internal" href="references.html#data">Data</a></li>
<li class="toctree-l3"><a class="reference internal" href="references.html#related-modules">Related Modules</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a><ul>
<li class="toctree-l2"><a class="reference internal" href="about.html#goal">Goal</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#contributing">Contributing</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#get-started-with-the-development">Get started with the development</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#improving-baselines">Improving Baselines</a></li>
<li class="toctree-l2"><a class="reference internal" href="about.html#adding-modules">Adding Modules</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">ECGAN</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li>Supported Functionality</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/supported.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="supported-functionality">
<h1>Supported Functionality<a class="headerlink" href="#supported-functionality" title="Permalink to this headline"></a></h1>
<p>This page serves as a concise overview of datasets and preprocessing, training and
evaluation methods currently supported by ECGAN.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Not all preprocessing methods supported by the framework are used for
every dataset and not every metric is in use for every method.
If you feel like we are missing crucial preprocessing or evaluation steps
please get in touch!</p>
</div>
<section id="supported-datasets">
<h2>Supported Datasets<a class="headerlink" href="#supported-datasets" title="Permalink to this headline"></a></h2>
<p>The dataset can best be set during initialization using the <code class="code docutils literal notranslate"><span class="pre">-b</span></code> flag followed by the identifier below.
We currently support the following datasets out of the box:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 9%" />
<col style="width: 9%" />
<col style="width: 22%" />
<col style="width: 30%" />
<col style="width: 30%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Dataset</p></th>
<th class="head"><p>Identifier</p></th>
<th class="head"><p>Dataset</p></th>
<th class="head"><p>Retriever</p></th>
<th class="head"><p>Preprocessor</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td rowspan="5"><p>MITBIH <sup>1</sup></p></td>
<td><p><code class="code docutils literal notranslate"><span class="pre">mitbih</span></code></p></td>
<td><p><a class="reference internal" href="api/utils/datasets.html#ecgan.utils.datasets.MitbihDataset" title="ecgan.utils.datasets.MitbihDataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.utils.datasets.MitbihDataset</span></code></a></p></td>
<td><p><a class="reference internal" href="api/preprocessing/data_retrieval.html#ecgan.preprocessing.data_retrieval.MitbihDataRetriever" title="ecgan.preprocessing.data_retrieval.MitbihDataRetriever"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.preprocessing.data_retrieval.MitbihDataRetriever</span></code></a></p></td>
<td><p>Not supported</p></td>
</tr>
<tr class="row-odd"><td rowspan="2"><p><code class="code docutils literal notranslate"><span class="pre">mitbih_beats</span></code></p></td>
<td rowspan="2"><p><a class="reference internal" href="api/utils/datasets.html#ecgan.utils.datasets.MitbihExtractedBeatsDataset" title="ecgan.utils.datasets.MitbihExtractedBeatsDataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.utils.datasets.MitbihExtractedBeatsDataset</span></code></a></p></td>
<td rowspan="2"><p><a class="reference internal" href="api/preprocessing/data_retrieval.html#ecgan.preprocessing.data_retrieval.MitbihExtractedBeatsDataRetriever" title="ecgan.preprocessing.data_retrieval.MitbihExtractedBeatsDataRetriever"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.preprocessing.data_retrieval.MitbihExtractedBeatsDataRetriever</span></code></a></p></td>
<td rowspan="2"><p><a class="reference internal" href="api/preprocessing/preprocessor.html#ecgan.preprocessing.preprocessor.MitbihExtractedBeatsPreprocessor" title="ecgan.preprocessing.preprocessor.MitbihExtractedBeatsPreprocessor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.preprocessing.preprocessor.MitbihExtractedBeatsPreprocessor</span></code></a></p></td>
</tr>
<tr class="row-even"></tr>
<tr class="row-odd"><td rowspan="2"><p><code class="code docutils literal notranslate"><span class="pre">mitbih_beatgan</span></code></p></td>
<td rowspan="2"><p><a class="reference internal" href="api/utils/datasets.html#ecgan.utils.datasets.MitbihBeatganDataset" title="ecgan.utils.datasets.MitbihBeatganDataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.utils.datasets.MitbihBeatganDataset</span></code></a></p></td>
<td rowspan="2"><p><a class="reference internal" href="api/preprocessing/data_retrieval.html#ecgan.preprocessing.data_retrieval.MitbihBeatganDataRetriever" title="ecgan.preprocessing.data_retrieval.MitbihBeatganDataRetriever"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.preprocessing.data_retrieval.MitbihBeatganDataRetriever</span></code></a></p></td>
<td rowspan="2"><p><a class="reference internal" href="api/preprocessing/preprocessor.html#ecgan.preprocessing.preprocessor.MitbihBeatganPreprocessor" title="ecgan.preprocessing.preprocessor.MitbihBeatganPreprocessor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.preprocessing.preprocessor.MitbihBeatganPreprocessor</span></code></a></p></td>
</tr>
<tr class="row-even"></tr>
<tr class="row-odd"><td rowspan="2"><p>Shaoxing <sup>2</sup></p></td>
<td rowspan="2"><p><code class="code docutils literal notranslate"><span class="pre">shaoxing</span></code></p></td>
<td rowspan="2"><p><a class="reference internal" href="api/utils/datasets.html#ecgan.utils.datasets.ShaoxingDataset" title="ecgan.utils.datasets.ShaoxingDataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.utils.datasets.ShaoxingDataset</span></code></a></p></td>
<td rowspan="2"><p><a class="reference internal" href="api/preprocessing/data_retrieval.html#ecgan.preprocessing.data_retrieval.ShaoxingDataRetriever" title="ecgan.preprocessing.data_retrieval.ShaoxingDataRetriever"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.preprocessing.data_retrieval.ShaoxingDataRetriever</span></code></a></p></td>
<td rowspan="2"><p><a class="reference internal" href="api/preprocessing/preprocessor.html#ecgan.preprocessing.preprocessor.ShaoxingPreprocessor" title="ecgan.preprocessing.preprocessor.ShaoxingPreprocessor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.preprocessing.preprocessor.ShaoxingPreprocessor</span></code></a></p></td>
</tr>
<tr class="row-even"></tr>
<tr class="row-odd"><td rowspan="2"><p>PTB <sup>3</sup></p></td>
<td rowspan="2"><p><code class="code docutils literal notranslate"><span class="pre">ptb</span></code></p></td>
<td rowspan="2"><p><a class="reference internal" href="api/utils/datasets.html#ecgan.utils.datasets.PTBExtractedBeatsDataset" title="ecgan.utils.datasets.PTBExtractedBeatsDataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.utils.datasets.PTBExtractedBeatsDataset</span></code></a></p></td>
<td rowspan="2"><p><a class="reference internal" href="api/preprocessing/data_retrieval.html#ecgan.preprocessing.data_retrieval.PtbExtractedBeatsDataRetriever" title="ecgan.preprocessing.data_retrieval.PtbExtractedBeatsDataRetriever"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.preprocessing.data_retrieval.PtbExtractedBeatsDataRetriever</span></code></a></p></td>
<td rowspan="2"><p><a class="reference internal" href="api/preprocessing/preprocessor.html#ecgan.preprocessing.preprocessor.PtbExtractedBeatsPreprocessor" title="ecgan.preprocessing.preprocessor.PtbExtractedBeatsPreprocessor"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.preprocessing.preprocessor.PtbExtractedBeatsPreprocessor</span></code></a></p></td>
</tr>
<tr class="row-even"></tr>
<tr class="row-odd"><td rowspan="2"><p>Synthetic sine <sup>4</sup></p></td>
<td rowspan="2"><p><code class="code docutils literal notranslate"><span class="pre">sine</span></code></p></td>
<td rowspan="2"><p><a class="reference internal" href="api/utils/datasets.html#ecgan.utils.datasets.SineDataset" title="ecgan.utils.datasets.SineDataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.utils.datasets.SineDataset</span></code></a></p></td>
<td rowspan="2"><p><a class="reference internal" href="api/preprocessing/data_retrieval.html#ecgan.preprocessing.data_retrieval.SineDataRetriever" title="ecgan.preprocessing.data_retrieval.SineDataRetriever"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.preprocessing.data_retrieval.SineDataRetriever</span></code></a></p></td>
<td rowspan="2"><p>Not supported</p></td>
</tr>
<tr class="row-even"></tr>
</tbody>
</table>
<div class="line-block">
<div class="line"><sup>1</sup> a. Paper: <a class="reference external" href="https://ieeexplore.ieee.org/abstract/document/932724">Moody and Mark 2001</a>, more information
on the <a class="reference external" href="https://physionet.org/content/mitdb/1.0.0/">PhysioNet MITBIH Website</a>. Data source: unofficial
<a class="reference external" href="https://www.kaggle.com/mondejar/mitbih-database/">kaggle mirror</a>. The data remains unchanged but is saved as csv.
This dataset needs manual preprocessing by the user, we only support the download.</div>
<div class="line"><sup>1</sup> b. Paper: <a class="reference external" href="https://arxiv.org/abs/1805.00794">Kachuee et al. 2018</a>. Data source:
<a class="reference external" href="https://www.kaggle.com/shayanfazeli/heartbeat">official Kaggle repository</a>. Classes are according to the AAMI classification, each beat is classified individually.</div>
<div class="line"><sup>1</sup> c. Paper: <a class="reference external" href="https://www.ijcai.org/Proceedings/2019/0616.pdf">Zhou et al. 2019</a>. Data source:
<a class="reference external" href="https://www.dropbox.com/sh/b17k2pb83obbrkn/AABF9mUNVdaYwce9fnwXsg1ta/ano0?dl=0&subfolder_nav_tracking=1">official Dropbox mirror</a>. Data is centered, standardized, classes are according to AAMI, each beat is classified individually.</div>
<div class="line"><sup>2</sup> Paper: <a class="reference external" href="https://pubmed.ncbi.nlm.nih.gov/32051412/">Zheng et al. 2020</a>. Data source:
<a class="reference external" href="https://figshare.com/collections/ChapmanECG/4560497/2">official figshare mirror</a>.</div>
<div class="line"><sup>3</sup> Original Paper: <a class="reference external" href="https://www.deepdyve.com/lp/de-gruyter/nutzung-der-ekg-signaldatenbank-cardiodat-der-ptb-ber-das-internet-uemKpjIFzM">Bousseljot et al. 1995</a>
Paper of data source: <a class="reference external" href="https://arxiv.org/abs/1805.00794">Kachuee et al. 2018</a>.
Data source: <a class="reference external" href="https://www.kaggle.com/shayanfazeli/heartbeat">official Kaggle repository</a>.</div>
<div class="line"><sup>4</sup> Artificial sine wave data, description can be found here: <a class="reference internal" href="api/preprocessing/data_retrieval.html#ecgan.preprocessing.data_retrieval.SineDataRetriever" title="ecgan.preprocessing.data_retrieval.SineDataRetriever"><code class="xref py py-class docutils literal notranslate"><span class="pre">ecgan.preprocessing.data_retrieval.SineDataRetriever</span></code></a>.</div>
</div>
<p>Additional public ECG datasets which are currently not supported include the recent PTB-XL from <a class="reference external" href="https://www.nature.com/articles/s41597-020-0495-6">Wagner et al. 2020</a>
and ECG 5000. More information on ECG datasets can be found on the <a class="reference external" href="https://physionet.org/about/database/">PhysioNet Database</a>.</p>
<p>Not all datasets are suitable for all tasks, the quality of the Shaoxing dataset is for example not necessarily high enough for reliable data generation.
We hope to add more information and in-depth evaluations for the supported datasets in the future.</p>
</section>
<section id="supported-preprocessing">
<h2>Supported Preprocessing<a class="headerlink" href="#supported-preprocessing" title="Permalink to this headline"></a></h2>
<p>The preprocessing is not set as a flag during initialization, but can be changed after initialization, before starting <code class="code docutils literal notranslate"><span class="pre">ecgan-preprocess</span></code>.
Most importantly, you can select the sequence length (<code class="code docutils literal notranslate"><span class="pre">TARGET_SEQUENCE_LENGTH</span></code>) and downsample or upsample the data.
This is very important since the sequence length can be very important for the performance of a model
and sometimes needs to be downsampled for computational requirements or upsampled to be a good fit
for an existing architecture with a specific sequence length in mind.
For downsampling we suggest using <a class="reference external" href="https://pypi.org/project/lttb/">LTTB</a> downsampling (<code class="code docutils literal notranslate"><span class="pre">DOWNSAMPLE_ALGO:</span> <span class="pre">lttb</span></code>) to retain the structure of the time series.
For upsampling we support the torch interpolation (<code class="code docutils literal notranslate"><span class="pre">DOWNSAMPLE_ALGO:</span> <span class="pre">interpolate</span></code>) which uses linear interpolation between the values.</p>
</section>
<section id="supported-training">
<h2>Supported Training<a class="headerlink" href="#supported-training" title="Permalink to this headline"></a></h2>
<p>During training data is split into n Folds (<code class="code docutils literal notranslate"><span class="pre">CROSS_VAL_FOLDS</span></code> in the configuration file).
Many parameters such the desired (amount of) channels (either a list for the selected indices or an integer m
to take the first m channels), flags to indicate if data shall be masked for binary classification
(<code class="code docutils literal notranslate"><span class="pre">BINARY_LABELS</span></code>), transformations such as various normalizations or the Fourier transform (<code class="code docutils literal notranslate"><span class="pre">TRANSFORMATION</span></code>)
can be set. It is further possible to train solely on healthy data which can be useful for some tasks such
as various generative tasks.
Other parameters which are of relevance for training many models (currently focusing deep learning models)
can be set freely such as the amount of epochs or the batch size.</p>
</section>
<section id="supported-models">
<h2>Supported Models<a class="headerlink" href="#supported-models" title="Permalink to this headline"></a></h2>
<p>Can be selected using the <code class="code docutils literal notranslate"><span class="pre">-m</span></code> flag.</p>
<ol class="arabic">
<li><p>Data generation/synthesis:</p>
<blockquote>
<div><ol class="loweralpha simple">
<li><p>Traditional GAN based models (especially DCGAN/RGAN) with a variety of <a class="reference internal" href="api/utils/losses.html#module-ecgan.utils.losses"><span class="std std-ref">Loss functions</span></a>. Usage <code class="code docutils literal notranslate"><span class="pre">-m</span> <span class="pre">dcgan</span></code>, <code class="code docutils literal notranslate"><span class="pre">-m</span> <span class="pre">rgan</span></code>, <code class="code docutils literal notranslate"><span class="pre">-m</span> <span class="pre">rdcgan</span></code>.</p></li>
<li><p>Autoencoder based GANs: using a (variational) autoencoder. Usage <code class="code docutils literal notranslate"><span class="pre">-m</span> <span class="pre">aegan</span></code>, <code class="code docutils literal notranslate"><span class="pre">-m</span> <span class="pre">vaegan</span></code>.</p></li>
</ol>
</div></blockquote>
</li>
<li><p>Data classification:</p>
<blockquote>
<div><ol class="loweralpha simple">
<li><p>Simple RNN for (multiclass as well as single class) classification. Usage <code class="code docutils literal notranslate"><span class="pre">-m</span> <span class="pre">rnn</span></code>.</p></li>
<li><p>Simple CNN for (multiclass as well as single class) classification. Usage <code class="code docutils literal notranslate"><span class="pre">-m</span> <span class="pre">cnn</span></code>.</p></li>
</ol>
</div></blockquote>
</li>
</ol>
</section>
<section id="supported-trackers">
<h2>Supported trackers<a class="headerlink" href="#supported-trackers" title="Permalink to this headline"></a></h2>
<p>Training and evaluation can be tracked using <a class="reference internal" href="api/evaluation/tracker.html#module-ecgan.evaluation.tracker"><span class="std std-ref">Tracker</span></a> which can be set using the <code class="code docutils literal notranslate"><span class="pre">TRACKER</span></code>
parameter in the experiment config. Currently supported options are local tracking (<code class="code docutils literal notranslate"><span class="pre">TRACKER:</span> <span class="pre">local</span></code>)
and Weights and Biases (<code class="code docutils literal notranslate"><span class="pre">TRACKER:</span> <span class="pre">wb</span></code>). While local tracking is set as a default to not force people to
sign up for another service to test ecgan, we strongly recommend Weights and Biases!</p>
</section>
<section id="further-downstream-tasks">
<h2>Further downstream tasks<a class="headerlink" href="#further-downstream-tasks" title="Permalink to this headline"></a></h2>
<p>The most important downstream tasks is the anomaly detection, see <a class="reference internal" href="anomaly_detection.html#anomaly-detection"><span class="std std-ref">Anomaly Detection</span></a> for detailed information.
Supported techniques currently focus on pretrained models and include both, classification as well as generative models.</p>
<p>Additionally, inverse mappings can be trained for selected deep generative models. See <a class="reference internal" href="api/modules/inverse_mapping/inverse_mapping.html#module-ecgan.modules.inverse_mapping.inverse_mapping"><span class="std std-ref">Inverse Mapping</span></a> for more information.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="structure.html" class="btn btn-neutral float-left" title="ECGAN Structure" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="preprocessing.html" class="btn btn-neutral float-right" title="Preprocessing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2021, Fiete Lüer, Tobias Weber, Maxim Dolgich.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>