Metadata-Version: 2.4
Name: pyseter
Version: 0.3.2
Summary: Sort images by an automatically generated ID before photo-ID
Author-email: "Philip T. Patton" <philtpatton@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/philpatton/pyseter
Project-URL: Changelog, https://github.com/username/your-package/blob/main/CHANGELOG.md
Project-URL: Documentation, https://philpatton.github.io/pyseter
Project-URL: Repository, https://github.com/philpatton/pyseter
Project-URL: Bug Tracker, https://github.com/philpatton/pyseter/issues
Keywords: individual identification,pytorch,marine mammal
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.21.0
Requires-Dist: pandas>=1.3.0
Requires-Dist: scikit-learn>=1.1.0
Requires-Dist: networkx>=2.6.0
Requires-Dist: matplotlib>=3.5.0
Requires-Dist: tqdm>=4.60.0
Requires-Dist: timm>=0.6.0
Requires-Dist: huggingface-hub>=0.16.0
Requires-Dist: gradio>=5.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Dynamic: license-file

# Pyseter

Pyseter is an open-source Python package for automating photo-identification. Pyseter includes functions for:

- Extracting feature vectors from images with the [AnyDorsal](https://besjournals.onlinelibrary.wiley.com/doi/10.1111/2041-210X.14167) algorithm 
- Clustering images by a proposed ID
- Sorting images into directories by proposed ID then encounter
- Grading images by distinctiveness (experimental)
- Identifying individuals using a reference set
- Evaluating photo-ID algorithms

## Introduction 

Please see the [Getting Started](getting-started.qmd) page for a demonstration of the basic functionality of Pyseter using an example of spinner dolphins.

## Installation

Users can install Pyseter with pip, uv, or pixi. For example, 

```bash
pip install pyseter
```

We imagine that most Pyseter users will be more familiar with R than Python. If this is you, please see the [R users who are new to Python](install-r.qmd) page for detailed instructions on the steps needed to work with Pyseter. 
