Metadata-Version: 2.1
Name: ecgdatasets
Version: 0.0.1
Home-page: https://github.com/rostepifanov/ecgdatasets
Author: Rostislav Epifanov
Author-email: rostepifanov@gmail.com
License: MIT
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: torch >=1.4.0
Requires-Dist: tqdm >=4.40.0
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: wfdb >=4.1.2 ; extra == 'tests'

# **E**cg**d**ata**s**ets

## Table of contents
- [Authors](#authors)
- [Installation](#installation)
- [A simple example](#a-simple-example)
- [Available datasets](#available-datasets)
- [Citing](#citing)

## Authors
[**Rostislav Epifanov** — Researcher in Novosibirsk]()

## Installation
Installation from PyPI:

```
pip install ecgdatasets
```

Installation from GitHub:

```
pip install git+https://github.com/rostepifanov/ecgdatasets
```

## A simple example

```python
import ecgdatasets as edb
from torch.utils.data import DataLoader

# torch.Dataset
dataset = edb.PTBXL('.', '1.0.3', download=True, mapper=None)

# torch.DataLoader that is ready to use with torch.nn.Module
dataloader = DataLoader(dataset, batch_size=32, shuffle=True)
```

## Available datasets

| Name      | Labels | Source |
| ---:      | :---:  | :---: |
| LUDB      | -      | [Physionet](https://physionet.org/content/ludb/) |
| PTBXL     | -      | [Physionet](https://physionet.org/content/ptb-xl/) |
| INCARTDB  | -      | [Physionet](https://physionet.org/content/ptb-xl/)|

## Citing

If you find this library useful for your research, please consider citing:

```
@misc{epifanov2023ecgdatasets,
  Author = {Rostislav Epifanov},
  Title = {Ecgdatasets},
  Year = {2023},
  Publisher = {GitHub},
  Journal = {GitHub repository},
  Howpublished = {\url{https://github.com/rostepifanov/ecgdatasets}}
}
```
