Installation

In order to install and use Plug-AI, you have multiple options: 1. from source 2. from pip 3. on Jean-Zay cluster: you can avoid the installation by using a specific module with Plug-AI pre-installed on it(work in progress).

From source

If you want to install from sources, you can clone the git repositery and install from here:

git clone https://github.com/CaroleFri/Plug-AI.git
cd Plug-AI
pip install .

Using pip (Work in progress)

pip install git+https://github.com/CaroleFri/Plug-AI

Reminder: On jean-zay, you must do installations using :

pip install --user --no-cache-dir git+https://github.com/CaroleFri/Plug-AI

Usage on Jean-zay cluster

The module containing plug_ai is in progress.

For now you can use Jean-Zay by first loading the following module:

module load pytorch-gpu/py/1.11.0

Then you can the installation with:

pip install --user --no-cache-dir git+https://github.com/CaroleFri/Plug-AI

If you want to use a notebook on JupyterHub, you can load once JupyterHub is ready by:

Going into the software section (blue hexagonal buttong at the bottom left)
Searching for module WIP
Loading the module

Alternatively, you can also define a specific module for one notebook and not the whole session by selecting the module as the running kernel after you opened the notebook.