/PoseR

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

PoseR

License BSD-3 PyPI Python Version tests codecov napari hub

A deep learning toolbox for decoding animal behaviour


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

alt text

Installation

Create an anaconda environment:

conda create -n PoseR python=3.10

Activate PoseR environment:

conda activate PoseR

Install CUDA if using NVIDIA GPU:

conda install -c "nvidia/label/cuda-11.7.0" cuda

Install Pytorch: For GPU:

conda install pytorch torchvision torchaudio pytorch-cuda=11.7 -c pytorch -c nvidia

For CPU only version:

conda install pytorch torchvision torchaudio cpuonly -c pytorch

Install napari:

pip install napari[all]==0.4.14 npe2==0.6.2 pydantic==1.10.4

You can install PoseR via pip:

pip install PoseR-napari

To install latest development version :

pip install git+https://github.com/pnm4sfix/PoseR.git

Quick start

https://github.com/pnm4sfix/PoseR/blob/generalise-species/docs/QuickStart.md

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 BSD-3 license, "PoseR" is free and open source software

Issues

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