<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Slideflow Documentation — slideflow 3.0.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!-- <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> -->
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index" href="genindex/" />
<link rel="search" title="Search" href="search/" />
<link rel="next" title="Installation" href="installation/" />
<script src="_static/js/modernizr.min.js"></script>
<!-- Preload the theme fonts -->
<link rel="preload" href="_static/fonts/FreightSans/freight-sans-book.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="_static/fonts/FreightSans/freight-sans-bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="_static/fonts/FreightSans/freight-sans-medium-italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="_static/fonts/IBMPlexMono/IBMPlexMono-SemiBold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<!-- Preload the katex fonts -->
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Math-Italic.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Main-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Main-Bold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size1-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size4-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size2-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Size3-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/fonts/KaTeX_Caligraphic-Regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.15.2/css/all.css" integrity="sha384-vSIIfh2YWi9wW0r9iZe7RJPrKwp6bG+s9QZMoITbCckVJqGCCRhc+ccxNcdpHuYu" crossorigin="anonymous">
<script defer data-domain="slideflow.dev" src="https://plausible.io/js/script.js"></script>
</head>
<div class="container-fluid header-holder tutorials-header" id="header-holder">
<div class="container">
<div class="header-container">
<a class="header-logo" href="https://slideflow.dev" aria-label="Slideflow"></a>
<div class="main-menu">
<ul>
<li class="active">
<a href="https://slideflow.dev">Docs</a>
</li>
<li>
<a href="https://slideflow.dev/tutorial1/">Tutorials</a>
</li>
<li>
<a href="https://github.com/slideflow/slideflow">GitHub</a>
</li>
</ul>
</div>
<a class="main-menu-open-button" href="#" data-behavior="open-mobile-menu"></a>
</div>
</div>
</div>
<body class="pytorch-body">
<div class="table-of-contents-link-wrapper">
<span>Table of Contents</span>
<a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
</div>
<nav data-toggle="wy-nav-shift" class="pytorch-left-menu" id="pytorch-left-menu">
<div class="pytorch-side-scroll">
<div class="pytorch-menu pytorch-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<div class="pytorch-left-menu-search">
<div class="version">
3.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search/" method="get">
<input type="text" name="q" placeholder="Search Docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation/">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview/">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart/">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="project_setup/">Setting up a Project</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets_and_val/">Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="slide_processing/">Slide Processing</a></li>
<li class="toctree-l1"><a class="reference internal" href="training/">Training</a></li>
<li class="toctree-l1"><a class="reference internal" href="evaluation/">Evaluation</a></li>
<li class="toctree-l1"><a class="reference internal" href="posthoc/">Layer Activations</a></li>
<li class="toctree-l1"><a class="reference internal" href="uq/">Uncertainty Quantification</a></li>
<li class="toctree-l1"><a class="reference internal" href="features/">Generating Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="mil/">Multiple-Instance Learning (MIL)</a></li>
<li class="toctree-l1"><a class="reference internal" href="ssl/">Self-Supervised Learning (SSL)</a></li>
<li class="toctree-l1"><a class="reference internal" href="stylegan/">Generative Networks (GANs)</a></li>
<li class="toctree-l1"><a class="reference internal" href="saliency/">Saliency Maps</a></li>
<li class="toctree-l1"><a class="reference internal" href="segmentation/">Tissue Segmentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="cellseg/">Cell Segmentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_loops/">Custom Training Loops</a></li>
<li class="toctree-l1"><a class="reference internal" href="studio/">Slideflow Studio: Live Visualization</a></li>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting/">Troubleshooting</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer Notes</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tfrecords/">TFRecords: Reading and Writing</a></li>
<li class="toctree-l1"><a class="reference internal" href="dataloaders/">Dataloaders: Sampling and Augmentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_extractors/">Custom Feature Extractors</a></li>
<li class="toctree-l1"><a class="reference internal" href="tile_labels/">Strong Supervision with Tile Labels</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins/">Creating a Slideflow Plugin</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="slideflow/">slideflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="project/">slideflow.Project</a></li>
<li class="toctree-l1"><a class="reference internal" href="dataset/">slideflow.Dataset</a></li>
<li class="toctree-l1"><a class="reference internal" href="dataset_features/">slideflow.DatasetFeatures</a></li>
<li class="toctree-l1"><a class="reference internal" href="heatmap/">slideflow.Heatmap</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_params/">slideflow.ModelParams</a></li>
<li class="toctree-l1"><a class="reference internal" href="mosaic/">slideflow.Mosaic</a></li>
<li class="toctree-l1"><a class="reference internal" href="slidemap/">slideflow.SlideMap</a></li>
<li class="toctree-l1"><a class="reference internal" href="biscuit/">slideflow.biscuit</a></li>
<li class="toctree-l1"><a class="reference internal" href="slideflow_cellseg/">slideflow.cellseg</a></li>
<li class="toctree-l1"><a class="reference internal" href="io/">slideflow.io</a></li>
<li class="toctree-l1"><a class="reference internal" href="io_tensorflow/">slideflow.io.tensorflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="io_torch/">slideflow.io.torch</a></li>
<li class="toctree-l1"><a class="reference internal" href="gan/">slideflow.gan</a></li>
<li class="toctree-l1"><a class="reference internal" href="grad/">slideflow.grad</a></li>
<li class="toctree-l1"><a class="reference internal" href="mil_module/">slideflow.mil</a></li>
<li class="toctree-l1"><a class="reference internal" href="model/">slideflow.model</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_tensorflow/">slideflow.model.tensorflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_torch/">slideflow.model.torch</a></li>
<li class="toctree-l1"><a class="reference internal" href="norm/">slideflow.norm</a></li>
<li class="toctree-l1"><a class="reference internal" href="simclr/">slideflow.simclr</a></li>
<li class="toctree-l1"><a class="reference internal" href="slide/">slideflow.slide</a></li>
<li class="toctree-l1"><a class="reference internal" href="slide_qc/">slideflow.slide.qc</a></li>
<li class="toctree-l1"><a class="reference internal" href="stats/">slideflow.stats</a></li>
<li class="toctree-l1"><a class="reference internal" href="util/">slideflow.util</a></li>
<li class="toctree-l1"><a class="reference internal" href="studio_module/">slideflow.studio</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial1/">Tutorial 1: Model training (simple)</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial2/">Tutorial 2: Model training (advanced)</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial3/">Tutorial 3: Using a custom architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial4/">Tutorial 4: Model evaluation & heatmaps</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial5/">Tutorial 5: Creating a mosaic map</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial6/">Tutorial 6: Custom slide filtering</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial7/">Tutorial 7: Training with custom augmentations</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial8/">Tutorial 8: Multiple-Instance Learning</a></li>
</ul>
</div>
</div>
</nav>
<div class="pytorch-container">
<div class="pytorch-page-level-bar" id="pytorch-page-level-bar">
<div class="pytorch-breadcrumbs-wrapper">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="pytorch-breadcrumbs">
<li>
<a href="#">
Docs
</a> >
</li>
<li>Slideflow Documentation</li>
<li class="pytorch-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"><img src="_static/images/view-page-source-icon.svg"></a>
</li>
</ul>
</div>
</div>
<div class="pytorch-shortcuts-wrapper" id="pytorch-shortcuts-wrapper">
Shortcuts
</div>
</div>
<section data-toggle="wy-nav-shift" id="pytorch-content-wrap" class="pytorch-content-wrap">
<div class="pytorch-content-left">
<div class="rst-content">
<div role="main" class="main-content" itemscope="itemscope" itemtype="http://schema.org/Article">
<article itemprop="articleBody" id="pytorch-article" class="pytorch-article">
<figure class="align-default">
<img alt="https://i.imgur.com/YrsKN4I.jpeg" src="https://i.imgur.com/YrsKN4I.jpeg" />
</figure>
<section id="slideflow-documentation">
<h1>Slideflow Documentation<a class="headerlink" href="#slideflow-documentation" title="Permalink to this heading">¶</a></h1>
<p>Slideflow is a Python package that provides a unified API for building and testing deep learning models for histopathology, supporting both Tensorflow/Keras and PyTorch.</p>
<p>Slideflow includes tools for efficient whole-slide image processing, easy and highly customizable model training with uncertainty quantification (UQ), and a number of functional tools to assist with analysis and interpretability, including predictive heatmaps, mosaic maps, GANs, saliency maps, and more. It is built with both <a class="reference external" href="https://www.tensorflow.org/">Tensorflow/Keras</a> and <a class="reference external" href="https://pytorch.org">PyTorch</a> backends, with fully cross-compatible TFRecord data storage.</p>
<p>This documentation starts with a high-level overview of the pipeline and includes examples of how to perform common tasks using the <code class="docutils literal notranslate"><span class="pre">Project</span></code> helper class. We also provide several tutorials with examples of how Slideflow can be used and extended for additional functionality.</p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation/">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview/">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart/">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="project_setup/">Setting up a Project</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets_and_val/">Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="slide_processing/">Slide Processing</a></li>
<li class="toctree-l1"><a class="reference internal" href="training/">Training</a></li>
<li class="toctree-l1"><a class="reference internal" href="evaluation/">Evaluation</a></li>
<li class="toctree-l1"><a class="reference internal" href="posthoc/">Layer Activations</a></li>
<li class="toctree-l1"><a class="reference internal" href="uq/">Uncertainty Quantification</a></li>
<li class="toctree-l1"><a class="reference internal" href="features/">Generating Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="mil/">Multiple-Instance Learning (MIL)</a></li>
<li class="toctree-l1"><a class="reference internal" href="ssl/">Self-Supervised Learning (SSL)</a></li>
<li class="toctree-l1"><a class="reference internal" href="stylegan/">Generative Networks (GANs)</a></li>
<li class="toctree-l1"><a class="reference internal" href="saliency/">Saliency Maps</a></li>
<li class="toctree-l1"><a class="reference internal" href="segmentation/">Tissue Segmentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="cellseg/">Cell Segmentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_loops/">Custom Training Loops</a></li>
<li class="toctree-l1"><a class="reference internal" href="studio/">Slideflow Studio: Live Visualization</a></li>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting/">Troubleshooting</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Developer Notes</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tfrecords/">TFRecords: Reading and Writing</a></li>
<li class="toctree-l1"><a class="reference internal" href="dataloaders/">Dataloaders: Sampling and Augmentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom_extractors/">Custom Feature Extractors</a></li>
<li class="toctree-l1"><a class="reference internal" href="tile_labels/">Strong Supervision with Tile Labels</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugins/">Creating a Slideflow Plugin</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="slideflow/">slideflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="project/">slideflow.Project</a></li>
<li class="toctree-l1"><a class="reference internal" href="dataset/">slideflow.Dataset</a></li>
<li class="toctree-l1"><a class="reference internal" href="dataset_features/">slideflow.DatasetFeatures</a></li>
<li class="toctree-l1"><a class="reference internal" href="heatmap/">slideflow.Heatmap</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_params/">slideflow.ModelParams</a></li>
<li class="toctree-l1"><a class="reference internal" href="mosaic/">slideflow.Mosaic</a></li>
<li class="toctree-l1"><a class="reference internal" href="slidemap/">slideflow.SlideMap</a></li>
<li class="toctree-l1"><a class="reference internal" href="biscuit/">slideflow.biscuit</a></li>
<li class="toctree-l1"><a class="reference internal" href="slideflow_cellseg/">slideflow.cellseg</a></li>
<li class="toctree-l1"><a class="reference internal" href="io/">slideflow.io</a></li>
<li class="toctree-l1"><a class="reference internal" href="io_tensorflow/">slideflow.io.tensorflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="io_torch/">slideflow.io.torch</a></li>
<li class="toctree-l1"><a class="reference internal" href="gan/">slideflow.gan</a></li>
<li class="toctree-l1"><a class="reference internal" href="grad/">slideflow.grad</a></li>
<li class="toctree-l1"><a class="reference internal" href="mil_module/">slideflow.mil</a></li>
<li class="toctree-l1"><a class="reference internal" href="model/">slideflow.model</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_tensorflow/">slideflow.model.tensorflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="model_torch/">slideflow.model.torch</a></li>
<li class="toctree-l1"><a class="reference internal" href="norm/">slideflow.norm</a></li>
<li class="toctree-l1"><a class="reference internal" href="simclr/">slideflow.simclr</a></li>
<li class="toctree-l1"><a class="reference internal" href="slide/">slideflow.slide</a></li>
<li class="toctree-l1"><a class="reference internal" href="slide_qc/">slideflow.slide.qc</a></li>
<li class="toctree-l1"><a class="reference internal" href="stats/">slideflow.stats</a></li>
<li class="toctree-l1"><a class="reference internal" href="util/">slideflow.util</a></li>
<li class="toctree-l1"><a class="reference internal" href="studio_module/">slideflow.studio</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial1/">Tutorial 1: Model training (simple)</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial2/">Tutorial 2: Model training (advanced)</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial3/">Tutorial 3: Using a custom architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial4/">Tutorial 4: Model evaluation & heatmaps</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial5/">Tutorial 5: Creating a mosaic map</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial6/">Tutorial 6: Custom slide filtering</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial7/">Tutorial 7: Training with custom augmentations</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial8/">Tutorial 8: Multiple-Instance Learning</a></li>
</ul>
</div>
</section>
</article>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="installation/" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <img src="_static/images/chevron-right-orange.svg" class="next-page"></a>
</div>
<hr>
<div role="contentinfo">
<p>
© Copyright 2023, James M Dolezal.
</p>
</div>
<div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</div>
</footer>
</div>
</div>
<div class="pytorch-content-right" id="pytorch-content-right">
<div class="pytorch-right-menu" id="pytorch-right-menu">
<div class="pytorch-side-scroll" id="pytorch-side-scroll-right">
<ul>
<li><a class="reference internal" href="#">Slideflow Documentation</a><ul>
</ul>
</li>
</ul>
</div>
</div>
</div>
</section>
</div>
<script type="text/javascript" id="documentation_options" data-url_root="#" src="_static/documentation_options.js"></script>
<script data-url_root="#" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script type="text/javascript" src="_static/js/vendor/jquery-3.6.3.min.js"></script>
<script type="text/javascript" src="_static/js/vendor/popper.min.js"></script>
<script type="text/javascript" src="_static/js/vendor/bootstrap.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/list.js/1.5.0/list.min.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<!-- Begin Footer -->
<!-- End Footer -->
<!-- Begin Mobile Menu -->
<div class="mobile-main-menu">
<div class="container-fluid">
<div class="container">
<div class="mobile-main-menu-header-container">
<a class="header-logo" href="https://pytorch.org/" aria-label="PyTorch"></a>
<a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
</div>
</div>
</div>
<div class="mobile-main-menu-links-container">
<div class="main-menu">
<ul>
<li>
<a href="https://slideflow.dev">Docs</a>
</li>
<li>
<a href="https://slideflow.dev/tutorial1/">Tutorials</a>
</li>
<li>
<a href="https://github.com/slideflow/slideflow">Github</a>
</li>
</ul>
</div>
</div>
</div>
<!-- End Mobile Menu -->
<script script type="text/javascript">
var collapsedSections = [];
</script>
<script type="text/javascript" src="_static/js/vendor/anchor.min.js"></script>
<script type="text/javascript">
$(document).ready(function() {
mobileMenu.bind();
mobileTOC.bind();
pytorchAnchors.bind();
sideMenus.bind();
scrollToAnchor.bind();
highlightNavigation.bind();
mainMenuDropdown.bind();
filterTags.bind();
// Add class to links that have code blocks, since we cannot create links in code blocks
$("article.pytorch-article a span.pre").each(function(e) {
$(this).closest("a").addClass("has-code");
});
})
</script>
</body>
</html>