deepcell_types.utils.download_training_data

deepcell_types.utils.download_training_data(*, extract=False)

Download the public training-data corpus for deepcell-types (v1.1).

The compressed archive is downloaded to $HOME/.deepcell/data. The asset is pinned to a single released version; older versions are not available through this helper.

Note that the downloaded asset is a .zip and must be extracted before the contained tissuenet-*.zarr archive can be used as predict(zarr_path=...) / DEEPCELL_TYPES_ZARR_PATH. Pass extract=True to unpack it (via extract_archive(), which rejects path-traversal members) and receive the extraction directory.

Parameters:

extractbool, default=False

If True, extract the downloaded .zip next to itself and return the extraction directory instead of the .zip path.

Returns:

pathlib.Path

Local path to the downloaded .zip (or, when extract=True, the directory it was extracted into).