Branch | Test status |
---|---|
master | |
dev |
An open-source toolkit for computational pathology and machine learning.
View documentation
๐ง the dev
branch is under active development, with experimental features, bug fixes, and refactors that may happen at any time!
Stable versions are available as tagged releases on GitHub, or as versioned releases on PyPI
There are several ways to install PathML
:
pip install
from PyPI (recommended for users)- Clone repo to local machine and install from source (recommended for developers/contributors)
- Use the PathML Docker container
Options (1) and (2) require that you first install all external dependencies:
- openslide
- JDK 8
We recommend using conda for environment management. Download Miniconda here
Note: these instructions are for Linux. Commands may be different for other platforms.
Create conda environment:
conda create --name pathml python=3.8
conda activate pathml
Install external dependencies (Linux) with Apt:
sudo apt-get install openslide-tools g++ gcc libblas-dev liblapack-dev
Install external dependencies (MacOS) with Brew:
brew install openslide
Install OpenJDK 8:
conda install openjdk==8.0.152
Optionally install CUDA (instructions here)
Install PathML
from PyPI:
pip install pathml
Clone repo:
git clone https://github.com/Dana-Farber-AIOS/pathml.git
cd pathml
Create conda environment:
conda env create -f environment.yml
conda activate pathml
Optionally install CUDA (instructions here)
Install PathML
from source:
pip install -e .
First, download or build the PathML Docker container:
-
Option A: download PathML container from Docker Hub
docker pull pathml/pathml:latest
Optionally specify a tag for a particular version, e.g.
docker pull pathml/pathml:2.0.2
. To view possible tags, please refer to the PathML DockerHub page. -
Option B: build docker container from source
git clone https://github.com/Dana-Farber-AIOS/pathml.git cd pathml docker build -t pathml/pathml .
Then connect to the container:
docker run -it -p 8888:8888 pathml/pathml
The above command runs the container, which is configured to spin up a jupyter lab session and expose it on port 8888.
The terminal should display a URL to the jupyter lab session starting with http://127.0.0.1:8888/lab?token=<.....>
.
Navigate to that page and you should connect to the jupyter lab session running on the container with the pathml
environment fully configured. If a password is requested, copy the string of characters following the token=
in the
url.
Note that the docker container requires extra configurations to use with GPU.
Note that these instructions assume that there are no other processes using port 8888.
Please refer to the Docker run
documentation for further instructions
on accessing the container, e.g. for mounting volumes to access files on a local machine from within the container.
To use GPU acceleration for model training or other tasks, you must install CUDA. This guide should work, but for the most up-to-date instructions, refer to the official PyTorch installation instructions.
Check the version of CUDA:
nvidia-smi
Install correct version of cudatoolkit
:
# update this command with your CUDA version number
conda install cudatoolkit=11.0
After installing PyTorch, optionally verify successful PyTorch installation with CUDA support:
python -c "import torch; print(torch.cuda.is_available())"
Jupyter notebooks are a convenient way to work interactively. To use PathML
in Jupyter notebooks:
PathML relies on Java to enable support for reading a wide range of file formats.
Before using PathML
in Jupyter, you may need to manually set the JAVA_HOME
environment variable
specifying the path to Java. To do so:
- Get the path to Java by running
echo $JAVA_HOME
in the terminal in your pathml conda environment (outside of Jupyter) - Set that path as the
JAVA_HOME
environment variable in Jupyter:import os os.environ["JAVA_HOME"] = "/opt/conda/envs/pathml" # change path as needed
conda activate pathml
conda install ipykernel
python -m ipykernel install --user --name=pathml
This makes the pathml environment available as a kernel in jupyter lab or notebook.
PathML
is an open source project. Consider contributing to benefit the entire community!
There are many ways to contribute to PathML
, including:
- Submitting bug reports
- Submitting feature requests
- Writing documentation and examples
- Fixing bugs
- Writing code for new features
- Sharing workflows
- Sharing trained model parameters
- Sharing
PathML
with colleagues, students, etc.
See contributing for more details.
If you use PathML
please cite:
So far, PathML was used in the following manuscripts:
- A. Shmatko et al. Nature Cancer 2022
- J. Pocock et al. Nature Communications Medicine 2022
- A. Marcolini et al. SoftwareX 2022
- M. Rahman et al. Bioengineering 2022
- C. Lama et al. bioRxiv 2022
- D. Brundage et al. arXiv 2022
- S. Orsulic et al. Frontiers in Oncology 2022
- J. Linares et al. Molecular Cell 2021
This is where in the world our most enthusiastic supporters are located:
![]() |
and this is where they work:
![]() |
Source: https://ossinsight.io/analyze/Dana-Farber-AIOS/pathml#people
The GNU GPL v2 version of PathML is made available via Open Source licensing. The user is free to use, modify, and distribute under the terms of the GNU General Public License version 2.
Commercial license options are available also.
Questions? Comments? Suggestions? Get in touch!