mukkebude 0.1.2

A music generation library with transformer and lstm models',

Komposition-eines-Musikstuecks-mittels-Neuronaler-Netze

Ziel der Studienarbeit ist die Komposition eines kleinen Musikstücks. Die Komposition erfolgt mittels eines Neuronalen Netzes.

Usage

Hier wird beschrieben wir man das Projekt verwendet.

Installation

Um die unter demos bereitgestellten jupyter-notebook verwenden zu können, muss das Projekt mittels pip installiert werden. Hierfür gibt es folgende Möglichkeiten:

GitHub Repo

# Clone das Repo
git clone [e-mail]:DHBW-FN-TIT20/Komposition-eines-Musikstuecks-mittels-Neuronaler-Netze.git mukkeBude
cd mukkeBude

# Installieren mittels pip
pip install .

PyPi

pip install mukkeBude

Für die Verwendung der Jupyter-Notebooks muss jupyter-lab zusätzlich installiert werden!

pip install jupyterlab

Verwendung

Nach einer erfolgreichen installtion kann das modul mittels import mukkeBude verwendet werden. Entsprechende Beispiele sind unter demos zu finden.

Developing

Hier wird beschrieben, wie man seine Entwicklungsumgebung entsprechend vorbereitet, um an dem Projekt zu entwicklen. Empfohlen ist die Verwendung von Conda, da hier die Verwendung von der GPU deutlich einfach ist. Bei der Verwendung der anderen Methoden müssen unter Umständen weitere Schritte unternommen werden, um die GPU zu verwenden.

Conda

Installation mithilfe von conda:

conda env create -f environment.yml
conda activate tf-gpu

# Enable GPU support on Linux (need to be done in every new shell)
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$CONDA_PREFIX/lib/

Pip

Ohne venv:

pip install -r requirements-dev.txt

Mit venv:

python -m venv .venv
source .venv/bin/activate

pip install -r requirements-dev.txt

Poetry

poetry install --with=dev
poetry shell