Skip to main content

A napari plugin for segmentation using vision transformer features

Project description

Feature Forest

License BSD-3 PyPI Python Version tests codecov napari hub

A napari plugin for making image annotation using feature space of vision transformers and random forest classifier.
We developed a napari plugin to train a Random Forest model using extracted features of vision foundation models and just a few scribble labels provided by the user as input. This approach can do the segmentation of desired objects almost as well as manual segmentations but in a much shorter time with less manual effort.


Documentation

The plugin documentation is here.

Installation

To install this plugin you need to use conda or mamba to create a environment and install the requirements. Use the commands below to create the environment and install the plugin:

# for GPU
conda env create -f ./env_gpu.yml
# if you don't have a GPU
conda env create -f ./env_cpu.yml

Note: You need to install sam-2 which can be install easily using conda. To install sam-2 using pip please refer to the official sam-2 repository.

Requirements

  • python >= 3.10
  • numpy==1.24.4
  • opencv-python
  • scikit-learn
  • scikit-image
  • matplotlib
  • pyqt
  • magicgui
  • qtpy
  • napari
  • h5py
  • pytorch=2.3.1
  • torchvision=0.18.1
  • timm=1.0.9
  • pynrrd
  • segment-anything
  • sam-2

If you want to install the plugin manually using GPU, please follow the pytorch installation instruction here.
For detailed napari installation see here.

Installing The Plugin

If you use the provided conda environment yaml files, the plugin will be installed automatically. But in case you already have the environment setup, you can just install the plugin. First clone the repository:

git clone https://github.com/juglab/featureforest

Then run the following commands:

cd ./featureforest
pip install .

License

Distributed under the terms of the BSD-3 license, "featureforest" is free and open source software

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

featureforest-0.0.6.tar.gz (567.3 kB view details)

Uploaded Source

Built Distribution

featureforest-0.0.6-py3-none-any.whl (48.7 kB view details)

Uploaded Python 3

File details

Details for the file featureforest-0.0.6.tar.gz.

File metadata

  • Download URL: featureforest-0.0.6.tar.gz
  • Upload date:
  • Size: 567.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for featureforest-0.0.6.tar.gz
Algorithm Hash digest
SHA256 d6778bdce360a036a68e9a946c87b69cf92b557f4f01575a08be8cb5a176eb4b
MD5 23f4849e080923c285da11ee1d701fdd
BLAKE2b-256 9ca85b6b30b0d107d5bb81a6ead7390581f08a1ca2db6a8ea5e2fdc91df58800

See more details on using hashes here.

Provenance

The following attestation bundles were made for featureforest-0.0.6.tar.gz:

Publisher: setup_test_publish.yml on juglab/featureforest

Attestations:

File details

Details for the file featureforest-0.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for featureforest-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b9f1fd555456dba02cf2ce75ef5d5936f97530e439dffaccf575adbb4c355f03
MD5 43995d7e0d3ea78a9b5b3cb42f4d2d4d
BLAKE2b-256 27d84a2ce035460cee4b9609651f8de1e28cdf6f819abc56cca3f891370e6ea5

See more details on using hashes here.

Provenance

The following attestation bundles were made for featureforest-0.0.6-py3-none-any.whl:

Publisher: setup_test_publish.yml on juglab/featureforest

Attestations:

Supported by

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