Installation

Linux Instructions

OSL Dynamics can be installed in three steps. Open a Terminal and execute the following commands:

1. Create a virtual environment, we recommend using Anaconda: https://docs.anaconda.com/anaconda/install/index.html.

   Once you have installed Anaconda (or Miniconda) execute:

   conda create --name osld python=3.10
   conda activate osld
   

   Note, this environment must be activated every time you want to use osl-dynamics.

2. Install the deep learning library TensorFlow: https://www.tensorflow.org/overview (and the addon tensorflow-probability).

   To install TensorFlow use:

   pip install tensorflow==2.9.1
   

   If you have GPU resources you may need to install additional libraries (CUDA/cuDNN), see https://www.tensorflow.org/install/pip for detailed instructions.

   If you are using an Apple Mac, you will need to use the following instead:

   pip install tensorflow-macos==2.9.1
   

   If pip can not find the package, then you can try installing TensorFlow with conda:

   conda install tensorflow=2.9.1
   

   After you have installed TensorFlow, install the tensorflow-probability addon with:

   pip install tensorflow-probability==0.17
   

3. Finally, install osl-dynamics:

   pip install osl-dynamics
   

To remove osl-dynamics simply delete the conda environment:

conda env remove -n osld
conda clean --all

Windows Instructions

If you are using a Windows computer, we recommend first installing linux (Ubuntu) as a Windows Subsystem by following the instructions here. Then following the instructions above in the Ubuntu terminal.

Training Speed

You can test if you’ve succesfully installed osl-dynamics by running the HMM and DyNeMo simulation example scripts:

• HMM example.

• DyNeMo example.

A rough indication of the expected training speeds is given below. You could expect variations up to a factor of 2.

Training speed: ms/step

Computer	HMM	DyNeMo
M1/M2 Macbook	50	60
Linux with 1 GPU	100	20
Linux CPU	100	100