Merge pull request #380 from datamol-io/add-installation-instructions…

…-to-docs

Tidy + add IPU installation instructions

README.md

@@ -50,10 +50,10 @@ mkdir ~/.venv                               # Create the folder for the environm
 python3 -m venv ~/.venv/graphium_ipu        # Create the environment
 source ~/.venv/graphium_ipu/bin/activate    # Activate the environment
 
-# Installing the poptorch SDK. Make sure to change the path
+# Install the PopTorch wheel
 pip install PATH_TO_SDK/poptorch-3.2.0+109946_bb50ce43ab_ubuntu_20_04-cp38-cp38-linux_x86_64.whl
 
-# Activate poplar SDK.
+# Enable Poplar SDK (including Poplar and PopART)
 source PATH_TO_SDK/enable
 
 # Install the IPU specific and graphium requirements

docs/index.md

@@ -23,3 +23,24 @@ or pip:
 ```bash
 pip install graphium
 ```
+
+### IPU installation
+
+```bash
+mkdir ~/.venv                               # Create the folder for the environment
+python3 -m venv ~/.venv/graphium_ipu        # Create the environment
+source ~/.venv/graphium_ipu/bin/activate    # Activate the environment
+
+# Install the PopTorch wheel
+pip install PATH_TO_SDK/poptorch-3.2.0+109946_bb50ce43ab_ubuntu_20_04-cp38-cp38-linux_x86_64.whl
+
+# Enable Poplar SDK (including Poplar and PopART)
+source PATH_TO_SDK/enable
+
+# Install the IPU specific and graphium requirements
+PACKAGE_NAME=pytorch pip install -r requirements_ipu.txt
+pip install -r lightning.txt
+
+# Install Graphium in dev mode
+pip install --no-deps -e .
+```