From fc2949285451f0fe14456572c5eb09bc2e5fd642 Mon Sep 17 00:00:00 2001 From: unknown Date: Tue, 29 Oct 2024 10:24:08 -0400 Subject: [PATCH] updating docs --- docs/api.rst | 2 ++ docs/benchmark.rst | 9 ++++----- docs/settings.rst | 6 ++++-- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 8f87c927..6ae97b20 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -9,6 +9,8 @@ Cellpose class .. autoclass:: cellpose.models.Cellpose :members: +.. _cpmclass: + CellposeModel ~~~~~~~~~~~~~~~~~~ diff --git a/docs/benchmark.rst b/docs/benchmark.rst index d2dba1a9..ee0a9e3c 100644 --- a/docs/benchmark.rst +++ b/docs/benchmark.rst @@ -2,9 +2,8 @@ Timing + memory usage ------------------------------------ The algorithm runtime and memory usage increases with the data size. The runtimes -shown below are for a single image run for the first time on an A100 with a batch_size of 32 - - this timing includes warm-up of GPU, thus runtimes -will be faster for subsequent images. It will also be faster if you run many images of the same size +shown below are for a single image run once on an A100 with a batch_size of 32. +This timing includes warm-up of GPU, thus runtimes will be faster for subsequent images. It will also be faster if you run many images of the same size input as an array into Cellpose with a large batch_size. The runtimes will also be slightly faster if you have fewer cells/cell pixels. @@ -14,12 +13,12 @@ slightly faster if you have fewer cells/cell pixels. Table for 2D: .. image:: https://www.cellpose.org/static/images/benchmark_2d.png - :width: 400 + :width: 800 Table for 3D: .. image:: https://www.cellpose.org/static/images/benchmark_3d.png - :width: 400 + :width: 800 If you are running out of GPU memory for your images, you can reduce the ``batch_size`` parameter in the ``model.eval`` function or in the CLI (default is 8). diff --git a/docs/settings.rst b/docs/settings.rst index 955373a2..d5fc567c 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -4,11 +4,13 @@ Settings -------------------------- The important settings are described on this page. -See the :ref:`cpclass` for all run options. +See the :ref:`cpmclass` for all run options. Here is an example of calling the Cellpose class and running a list of images for reference: -::code-block:: + +:: + from cellpose import models from cellpose.io import imread