[![GitHub Org's stars](https://img.shields.io/github/stars/Janelia-cellmap)](https://github.com/janelia-cellmap)
<img src="https://raw.githubusercontent.com/janelia-cellmap/cellmap-models/main/assets/CellMapLogo2.png" alt="CellMap logo" width="85%">
# cellmap-models
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/janelia-cellmap/cellmap-models/total)
![GitHub License](https://img.shields.io/github/license/janelia-cellmap/cellmap-models)
![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fjanelia-cellmap%2Fcellmap-models%2Fmain%2Fpyproject.toml)
[![tests](https://github.com/janelia-cellmap/cellmap-models/actions/workflows/tests.yaml/badge.svg)](https://github.com/janelia-cellmap/cellmap-models/actions/workflows/tests.yaml)
[![black](https://github.com/janelia-cellmap/cellmap-models/actions/workflows/black.yaml/badge.svg)](https://github.com/janelia-cellmap/cellmap-models/actions/workflows/black.yaml)
[![mypy](https://github.com/janelia-cellmap/cellmap-models/actions/workflows/mypy.yaml/badge.svg)](https://github.com/janelia-cellmap/cellmap-models/actions/workflows/mypy.yaml)
[![codecov](https://codecov.io/gh/janelia-cellmap/cellmap-models/branch/main/graph/badge.svg)](https://codecov.io/gh/janelia-cellmap/cellmap-models)
This package contains the models used for segmention by the CellMap project team at HHMI Janelia.
## Installation
We strongly recommend installing within a [conda](https://docs.anaconda.com/free/miniconda/#quick-command-line-install) (or [mamba](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html#automatic-install)) environment to install the package.
```bash
conda env create -y -n cellmap python=3.10 pytorch -c pytorch
conda activate cellmap
pip install cellmap-models
```
## Usage
```python
import cellmap_models
```
Different models are available in the `cellmap-models` module. For example, to use the models produced by the `COSEM` pilot project team, and published as part of [Whole-cell organelle segmentation in volume electron microscopy](https://doi.org/10.1038/s41586-021-03977-3):
```python
import cellmap_models.cosem as cosem_models
print(cosem_models.models_list)
```
This will list the available models. To load a specific model, use the `load_model` function:
```python
model = cosem_models.load_model('setup04/1820500')
```
More information on each set of models and how to use them is available in the `README.md` file in the corresponding subdirectory.
Raw data
{
"_id": null,
"home_page": null,
"name": "cellmap-models",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "machine learning, deep learning, cell segmentation, cellpose, cellmap",
"author": null,
"author_email": "Jeff Rhoades <rhoadesj@hhmi.org>",
"download_url": "https://files.pythonhosted.org/packages/1e/8d/cbc58361b8a4d2d2ef9d041432dd6eed8a9c5d594c9e6db2b32aafd802f2/cellmap_models-0.0.5.tar.gz",
"platform": null,
"description": "[![GitHub Org's stars](https://img.shields.io/github/stars/Janelia-cellmap)](https://github.com/janelia-cellmap)\n\n\n<img src=\"https://raw.githubusercontent.com/janelia-cellmap/cellmap-models/main/assets/CellMapLogo2.png\" alt=\"CellMap logo\" width=\"85%\">\n\n# cellmap-models\n\n![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/janelia-cellmap/cellmap-models/total)\n![GitHub License](https://img.shields.io/github/license/janelia-cellmap/cellmap-models)\n![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fjanelia-cellmap%2Fcellmap-models%2Fmain%2Fpyproject.toml)\n\n[![tests](https://github.com/janelia-cellmap/cellmap-models/actions/workflows/tests.yaml/badge.svg)](https://github.com/janelia-cellmap/cellmap-models/actions/workflows/tests.yaml)\n[![black](https://github.com/janelia-cellmap/cellmap-models/actions/workflows/black.yaml/badge.svg)](https://github.com/janelia-cellmap/cellmap-models/actions/workflows/black.yaml)\n[![mypy](https://github.com/janelia-cellmap/cellmap-models/actions/workflows/mypy.yaml/badge.svg)](https://github.com/janelia-cellmap/cellmap-models/actions/workflows/mypy.yaml)\n[![codecov](https://codecov.io/gh/janelia-cellmap/cellmap-models/branch/main/graph/badge.svg)](https://codecov.io/gh/janelia-cellmap/cellmap-models)\n\nThis package contains the models used for segmention by the CellMap project team at HHMI Janelia.\n\n## Installation\n\nWe strongly recommend installing within a [conda](https://docs.anaconda.com/free/miniconda/#quick-command-line-install) (or [mamba](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html#automatic-install)) environment to install the package.\n\n```bash\nconda env create -y -n cellmap python=3.10 pytorch -c pytorch\nconda activate cellmap\npip install cellmap-models\n```\n\n## Usage\n\n```python\nimport cellmap_models\n```\n\nDifferent models are available in the `cellmap-models` module. For example, to use the models produced by the `COSEM` pilot project team, and published as part of [Whole-cell organelle segmentation in volume electron microscopy](https://doi.org/10.1038/s41586-021-03977-3):\n\n```python\nimport cellmap_models.cosem as cosem_models\nprint(cosem_models.models_list)\n```\nThis will list the available models. To load a specific model, use the `load_model` function:\n```python\nmodel = cosem_models.load_model('setup04/1820500')\n```\n\nMore information on each set of models and how to use them is available in the `README.md` file in the corresponding subdirectory.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "Repository of model architectures and network weights used for CellMap segmentations.",
"version": "0.0.5",
"project_urls": {
"homepage": "https://janelia-cellmap.github.io/cellmap-models",
"repository": "https://github.com/janelia-cellmap/cellmap-models"
},
"split_keywords": [
"machine learning",
" deep learning",
" cell segmentation",
" cellpose",
" cellmap"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ad79c9a9516fb7b320d5f0d39236ed0424c916b3499dd255a623c71152d44ce",
"md5": "26729ab6ce87b817723edc543f30803a",
"sha256": "c202c25ec9b715122e44c25e4e2d5498f1812ebe30511c0a0ded13e01517a346"
},
"downloads": -1,
"filename": "cellmap_models-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26729ab6ce87b817723edc543f30803a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 28926,
"upload_time": "2024-08-12T15:13:03",
"upload_time_iso_8601": "2024-08-12T15:13:03.620016Z",
"url": "https://files.pythonhosted.org/packages/4a/d7/9c9a9516fb7b320d5f0d39236ed0424c916b3499dd255a623c71152d44ce/cellmap_models-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e8dcbc58361b8a4d2d2ef9d041432dd6eed8a9c5d594c9e6db2b32aafd802f2",
"md5": "ed848fc75df9e69c418cc4436f80bc4e",
"sha256": "5c5703f7356163b822df9f04e294b6855bb556ff9fcfffe5551eccc42989d6ff"
},
"downloads": -1,
"filename": "cellmap_models-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "ed848fc75df9e69c418cc4436f80bc4e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 21700,
"upload_time": "2024-08-12T15:13:06",
"upload_time_iso_8601": "2024-08-12T15:13:06.457279Z",
"url": "https://files.pythonhosted.org/packages/1e/8d/cbc58361b8a4d2d2ef9d041432dd6eed8a9c5d594c9e6db2b32aafd802f2/cellmap_models-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-12 15:13:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "janelia-cellmap",
"github_project": "cellmap-models",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cellmap-models"
}