Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
carsen-stringer committed Oct 29, 2024
1 parent 5139630 commit fc29492
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
2 changes: 2 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Cellpose class
.. autoclass:: cellpose.models.Cellpose
:members:

.. _cpmclass:

CellposeModel
~~~~~~~~~~~~~~~~~~

Expand Down
9 changes: 4 additions & 5 deletions docs/benchmark.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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).
Expand Down
6 changes: 4 additions & 2 deletions docs/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit fc29492

Please sign in to comment.