Installing EEG-GAN

Pre-Requisites

The only prerequisites for installing EEG-GAN is Python.

---

Install With Pip

To install using pip:

  pip install eeggan

You can then import the package functions directly:

  Import functions: from eeggan import train_gan, visualize_gan, generate_samples
  Use function: train_gan(argv)

Or indirectly:

  Import package: import eeggan as eg
  Use function: eg.train_gan(argv)

If you prefer, follow this link to our PyPI page to directly download wheels or source.

---

Installing From the Source

You can install the latest GitHub version of EEG-GAN into your environment:

  pip install git+https://github.com/AutoResearch/EEG-GAN@3-release-as-pip-package

Note that our pip release is currently on the branch 3-release-as-pip-package.
Note that the GitHub repo may be ahead of the latest pip release.
For most stable results, we suggest you follow the Install With Pip instructions above.

---

Obtaining the Source

If you rather download the package via GitHub you can use the following command:

  git clone https://github.com/AutoResearch/EEG-GAN.git

To update your local package:

  git pull

Note that the GitHub repo may be ahead of the latest pip release.
For most stable results, we suggest you follow the Install With Pip instructions above.

---

Dependencies

The following are the required dependencies for EEG-GAN. If you install EEG-GAN via pip, or installed EEG-GAN from the source, these are automatically installed. If you have obtained the package from the source you can install these via the requirements.txt file pip install -r requirements.txt or via the pyproject.toml file pip install -e .[dev]

  Pandas~=1.3.4
  NumPy~=1.21.4
  Matplotlib~=3.5.0
  SciPy~=1.8.0
  Torch~=1.12.1
  TorchVision~=0.13.1
  TorchSummary~=1.5.1
  TorchAudio~=0.12.1
  Einops~=0.4.1
  Scikit-Learn~=1.1.2