napari-sketchpose


Namenapari-sketchpose JSON
Version 0.1.8 PyPI version JSON
download
home_page
SummaryA segmentation plugin to adapt Omnipose implementation to partial labelling.
upload_time2023-12-08 10:36:36
maintainer
docs_urlNone
authorClément Cazorla
requires_python>=3.8
licenseGPL-3.0-only
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # napari-sketchpose

[![License GNU GPL v3.0](https://img.shields.io/pypi/l/napari-sketchpose.svg?color=green)](https://github.com/koopa31/napari-sketchpose/raw/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/napari-sketchpose.svg?color=green)](https://pypi.org/project/napari-sketchpose)
[![Python Version](https://img.shields.io/pypi/pyversions/napari-sketchpose.svg?color=green)](https://python.org)
[![tests](https://github.com/koopa31/napari-sketchpose/workflows/tests/badge.svg)](https://github.com/koopa31/napari-sketchpose/actions)
[![codecov](https://codecov.io/gh/koopa31/napari-sketchpose/branch/main/graph/badge.svg)](https://codecov.io/gh/koopa31/napari-sketchpose)
[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-sketchpose)](https://napari-hub.org/plugins/napari-sketchpose)

A plugin to adapt the Omnipose implementation to frugal labeling. It aims to facilitate the training from scratch or the 
use of transfer learning with little data, by not needing to draw entire cells, but a few squiggles instead (see GIF below).


If you use this plugin please cite the [paper](https://hal.science/hal-04330824): 

Clément Cazorla, Nathanaël Munier, Renaud Morin, Pierre Weiss. Sketchpose: Learning to Segment
Cells with Partial Annotations. 2023. ffhal-04330824f

```bibtex
@unpublished{cazorla:hal-04330824,
      TITLE = {{Sketchpose: Learning to Segment Cells with Partial Annotations}},
      AUTHOR = {Cazorla, Cl{\'e}ment and Munier, Nathana{\"e}l and Morin, Renaud and Weiss, Pierre},
      URL = {https://hal.science/hal-04330824},
      NOTE = {working paper or preprint},
      YEAR = {2023},
      MONTH = Dec,
      KEYWORDS = {Cellpose -Segmentation -Frugal learning -Napari -Deep learning -Distance map},
      PDF = {https://hal.science/hal-04330824/file/sketchpose_hal.pdf},
      HAL_ID = {hal-04330824},
      HAL_VERSION = {v1},
    }

```


![](https://bitbucket.org/koopa31/napari-sketchpose/raw/b691817e9e20a3c1c2bc69277579f6fb9b26354e/images/frugalpose.gif)
Image Credit: Eduard Muzhevskyi
----------------------------------

This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.

<!--
Don't miss the full getting started guide to set up your new package:
https://github.com/napari/cookiecutter-napari-plugin#getting-started

and review the napari docs for plugin developers:
https://napari.org/stable/plugins/index.html
-->

## Installation



First, we advise you to create a conda environment in Python 3.10, in which you will run Napari:

    conda create -n sketchpose_env python=3.10
    conda activate sketchpose_env
    conda install pip
    python -m pip install "napari[all]" --upgrade

You can install `napari_sketchpose` via [pip]:

    pip install napari_sketchpose

WARNING:

For Windows users, CUDA version of PyTorch may not be installed properly. When the plugin starts for the first time, it checks whether
CUDA version is installed. If not, it tries to install it using light-the-torch library. If this does not work, you should re-install 
CUDA torch and torchvision versions manually, otherwise the plugin will not work properly.

## Tutorial

We strongly recommend reading the [documentation] to get the most out of the plugin.
A step-by-step tutorial illustrated with GIFs will guide you through the various stages.

## Contributing

Contributions are very welcome. Tests can be run with [tox], please ensure
the coverage at least stays the same before you submit a pull request.

## License

Distributed under the terms of the [GNU GPL v3.0] license,
"napari-sketchpose" is free and open source software

## Issues

If you encounter any problems, please [file an issue] along with a detailed description.

[napari]: https://github.com/napari/napari
[Cookiecutter]: https://github.com/audreyr/cookiecutter
[@napari]: https://github.com/napari
[MIT]: http://opensource.org/licenses/MIT
[BSD-3]: http://opensource.org/licenses/BSD-3-Clause
[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt
[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt
[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0
[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt
[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin

[napari]: https://github.com/napari/napari
[tox]: https://tox.readthedocs.io/en/latest/
[pip]: https://pypi.org/project/pip/
[PyPI]: https://pypi.org/
[documentation]: https://sketchpose-doc.readthedocs.io/en/latest/

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "napari-sketchpose",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Cl\u00e9ment Cazorla",
    "author_email": "clement.cazorla31@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/70/76/97b1b94c69b07c987637527848c333377336d666be0384216feca8872261/napari-sketchpose-0.1.8.tar.gz",
    "platform": null,
    "description": "# napari-sketchpose\n\n[![License GNU GPL v3.0](https://img.shields.io/pypi/l/napari-sketchpose.svg?color=green)](https://github.com/koopa31/napari-sketchpose/raw/main/LICENSE)\n[![PyPI](https://img.shields.io/pypi/v/napari-sketchpose.svg?color=green)](https://pypi.org/project/napari-sketchpose)\n[![Python Version](https://img.shields.io/pypi/pyversions/napari-sketchpose.svg?color=green)](https://python.org)\n[![tests](https://github.com/koopa31/napari-sketchpose/workflows/tests/badge.svg)](https://github.com/koopa31/napari-sketchpose/actions)\n[![codecov](https://codecov.io/gh/koopa31/napari-sketchpose/branch/main/graph/badge.svg)](https://codecov.io/gh/koopa31/napari-sketchpose)\n[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-sketchpose)](https://napari-hub.org/plugins/napari-sketchpose)\n\nA plugin to adapt the Omnipose implementation to frugal labeling. It aims to facilitate the training from scratch or the \nuse of transfer learning with little data, by not needing to draw entire cells, but a few squiggles instead (see GIF below).\n\n\nIf you use this plugin please cite the [paper](https://hal.science/hal-04330824): \n\nCl\u00e9ment Cazorla, Nathana\u00ebl Munier, Renaud Morin, Pierre Weiss. Sketchpose: Learning to Segment\nCells with Partial Annotations. 2023. ffhal-04330824f\n\n```bibtex\n@unpublished{cazorla:hal-04330824,\n      TITLE = {{Sketchpose: Learning to Segment Cells with Partial Annotations}},\n      AUTHOR = {Cazorla, Cl{\\'e}ment and Munier, Nathana{\\\"e}l and Morin, Renaud and Weiss, Pierre},\n      URL = {https://hal.science/hal-04330824},\n      NOTE = {working paper or preprint},\n      YEAR = {2023},\n      MONTH = Dec,\n      KEYWORDS = {Cellpose -Segmentation -Frugal learning -Napari -Deep learning -Distance map},\n      PDF = {https://hal.science/hal-04330824/file/sketchpose_hal.pdf},\n      HAL_ID = {hal-04330824},\n      HAL_VERSION = {v1},\n    }\n\n```\n\n\n![](https://bitbucket.org/koopa31/napari-sketchpose/raw/b691817e9e20a3c1c2bc69277579f6fb9b26354e/images/frugalpose.gif)\nImage Credit: Eduard Muzhevskyi\n----------------------------------\n\nThis [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.\n\n<!--\nDon't miss the full getting started guide to set up your new package:\nhttps://github.com/napari/cookiecutter-napari-plugin#getting-started\n\nand review the napari docs for plugin developers:\nhttps://napari.org/stable/plugins/index.html\n-->\n\n## Installation\n\n\n\nFirst, we advise you to create a conda environment in Python 3.10, in which you will run Napari:\n\n    conda create -n sketchpose_env python=3.10\n    conda activate sketchpose_env\n    conda install pip\n    python -m pip install \"napari[all]\" --upgrade\n\nYou can install `napari_sketchpose` via [pip]:\n\n    pip install napari_sketchpose\n\nWARNING:\n\nFor Windows users, CUDA version of PyTorch may not be installed properly. When the plugin starts for the first time, it checks whether\nCUDA version is installed. If not, it tries to install it using light-the-torch library. If this does not work, you should re-install \nCUDA torch and torchvision versions manually, otherwise the plugin will not work properly.\n\n## Tutorial\n\nWe strongly recommend reading the [documentation] to get the most out of the plugin.\nA step-by-step tutorial illustrated with GIFs will guide you through the various stages.\n\n## Contributing\n\nContributions are very welcome. Tests can be run with [tox], please ensure\nthe coverage at least stays the same before you submit a pull request.\n\n## License\n\nDistributed under the terms of the [GNU GPL v3.0] license,\n\"napari-sketchpose\" is free and open source software\n\n## Issues\n\nIf you encounter any problems, please [file an issue] along with a detailed description.\n\n[napari]: https://github.com/napari/napari\n[Cookiecutter]: https://github.com/audreyr/cookiecutter\n[@napari]: https://github.com/napari\n[MIT]: http://opensource.org/licenses/MIT\n[BSD-3]: http://opensource.org/licenses/BSD-3-Clause\n[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt\n[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt\n[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0\n[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt\n[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin\n\n[napari]: https://github.com/napari/napari\n[tox]: https://tox.readthedocs.io/en/latest/\n[pip]: https://pypi.org/project/pip/\n[PyPI]: https://pypi.org/\n[documentation]: https://sketchpose-doc.readthedocs.io/en/latest/\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-only",
    "summary": "A segmentation plugin to adapt Omnipose implementation to partial labelling.",
    "version": "0.1.8",
    "project_urls": {
        "Bug Tracker": "https://bitbucket.org/koopa31/napari-sketchpose/issues?status=new&status=open&status=submitted&is_spam=!spam",
        "Documentation": "https://sketchpose-doc.readthedocs.io/en/latest/",
        "Source Code": "https://bitbucket.org/koopa31/napari-sketchpose/src/master",
        "User Support": "https://bitbucket.org/koopa31/napari-sketchpose/issues?status=new&status=open&status=submitted&is_spam=!spam"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a5083547583f0c253f53b9030ce8bf70252106c8b686a5c8b72a00712eeaaab6",
                "md5": "d2db52e766567c4271753a96cb57f812",
                "sha256": "f383fa2cc73d3c2721a81f28d69dbeba880726c0bdab8b1783d224d24827b8a5"
            },
            "downloads": -1,
            "filename": "napari_sketchpose-0.1.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d2db52e766567c4271753a96cb57f812",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 99289,
            "upload_time": "2023-12-08T10:36:33",
            "upload_time_iso_8601": "2023-12-08T10:36:33.277872Z",
            "url": "https://files.pythonhosted.org/packages/a5/08/3547583f0c253f53b9030ce8bf70252106c8b686a5c8b72a00712eeaaab6/napari_sketchpose-0.1.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "707697b1b94c69b07c987637527848c333377336d666be0384216feca8872261",
                "md5": "4369eec3d940d57326e058a0cb74e39e",
                "sha256": "a580a09ec499a340303ef6b6859d351032bded5efed218c743b62499f808c2b4"
            },
            "downloads": -1,
            "filename": "napari-sketchpose-0.1.8.tar.gz",
            "has_sig": false,
            "md5_digest": "4369eec3d940d57326e058a0cb74e39e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 95375,
            "upload_time": "2023-12-08T10:36:36",
            "upload_time_iso_8601": "2023-12-08T10:36:36.300434Z",
            "url": "https://files.pythonhosted.org/packages/70/76/97b1b94c69b07c987637527848c333377336d666be0384216feca8872261/napari-sketchpose-0.1.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-08 10:36:36",
    "github": false,
    "gitlab": false,
    "bitbucket": true,
    "codeberg": false,
    "bitbucket_user": "koopa31",
    "bitbucket_project": "napari-sketchpose",
    "lcname": "napari-sketchpose"
}
        
Elapsed time: 0.14532s