Skip to main content

A simple plugin to use DinoSim in napari

Project description

DINOSim

License MIT biorxiv PyPI Python Version tests codecov napari hub

DINOSim-simple

A napari plugin for zero-shot image segmentation using DINO vision transformers.


Overview

napari-dinoSim allows users to perform zero-shot image segmentation by selecting reference points on an image. The plugin then computes similarity maps based on features extracted by DINOv2 and generates segmentation masks.

For detailed information on the widget's functionality, UI elements, and usage instructions, please refer to the Plugin Documentation. A simple example notebook demonstrating how to use DINOSim via code is also available.

Installation

You can install napari-dinoSim via pip. For GPU support (recommended), ensure you have a compatible PyTorch version installed with CUDA or MPS support.

pip install napari-dinosim

or from source via conda:

# Clone the repository
git clone https://github.com/AAitorG/napari-dinoSim.git
cd napari-dinoSim

# Create and activate the conda environment
conda env create -f environment.yml
conda activate napari-dinosim

Open the Plugin

To launch napari, run the following command in your terminal:

napari

Within the napari interface, locate the DINOSim segmentation plugin in the Plugins section of the top bar.

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 MIT license, "napari-dinoSim" is free and open source software

Citation

Please note that DINOSim is based on a publication. If you use it successfully for your research, please be so kind to cite our work:

@article {Gonzalez-Marfil2025dinosim,
    title = {DINOSim: Zero-Shot Object Detection and Semantic Segmentation on Electron Microscopy Images},
    author = {Gonz{\'a}lez-Marfil, Aitor and G{\'o}mez-de-Mariscal, Estibaliz and Arganda-Carreras, Ignacio},
    journal = {bioRxiv}
    publisher = {Cold Spring Harbor Laboratory},
    url = {https://www.biorxiv.org/content/early/2025/03/13/2025.03.09.642092},
    doi = {10.1101/2025.03.09.642092},
    year = {2025},
}

Issues

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

napari_dinosim-0.1.0.tar.gz (39.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

napari_dinosim-0.1.0-py3-none-any.whl (40.5 kB view details)

Uploaded Python 3

File details

Details for the file napari_dinosim-0.1.0.tar.gz.

File metadata

  • Download URL: napari_dinosim-0.1.0.tar.gz
  • Upload date:
  • Size: 39.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for napari_dinosim-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5edf3d515b4d9ccb32d493cb7e8fbfc2b37c561e4afd0a7009f2a70bab25d3e9
MD5 46182b9e66c982e9dae14100083b01e8
BLAKE2b-256 e9fddfabeee4e94abdb4fa4011e2259e74ee4af7dc77499c813507f5ed4447ac

See more details on using hashes here.

File details

Details for the file napari_dinosim-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: napari_dinosim-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 40.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for napari_dinosim-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cc5845ea3f8333603839d5768fea914d4d6d5109c05ef82b67070e3d2327716d
MD5 5029979ec183628b2064d8edc2811f16
BLAKE2b-256 e9d6e7beb3c84e43277190bd61099bdfb181f41e6d0c8489509633f002c1bde3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page