Metadata-Version: 2.1
Name: viame
Version: 0.23.5
Summary: VIAME: Video and Image Analytics for Multiple Environments
License: BSD-3-Clause
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Project-URL: Homepage, https://www.viametoolkit.org
Project-URL: Source, https://github.com/VIAME/VIAME
Project-URL: Documentation, https://viame.readthedocs.io
Project-URL: Issues, https://github.com/VIAME/VIAME/issues
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Dist: numpy>=1.24.4
Requires-Dist: av
Requires-Dist: scriptconfig
Requires-Dist: ubelt
Requires-Dist: pillow>=9.4.0
Requires-Dist: pyyaml
Requires-Dist: scipy
Requires-Dist: onnxruntime
Requires-Dist: ensemble_boxes
Requires-Dist: kwimage[headless]
Requires-Dist: kwcoco
Requires-Dist: kwarray
Requires-Dist: ndsampler
Requires-Dist: astunparse
Requires-Dist: pygtrie
Requires-Dist: networkx_algo_common_subtree
Requires-Dist: torch_liberator
Requires-Dist: liberator
Requires-Dist: requests
Requires-Dist: tqdm>=4.66.1
Requires-Dist: transformers>=5.1.0,<6.0.0
Requires-Dist: pydantic>=2.0,<3
Requires-Dist: pyDeprecate>=0.9,<0.10
Requires-Dist: supervision
Requires-Dist: hydra-core>=1.3.2
Requires-Dist: iopath>=0.1.10
Requires-Dist: torch>=2.11
Requires-Dist: torchvision>=0.18.1

# VIAME

**Video and Image Analytics for Multiple Environments.**

Originally made for marine life detection, VIAME has evolved into a general
open-source computer vision toolkit for analysing imagery and video:
detection, tracking, classification, size measurement, stereo/multi-camera
processing, search and training, assembled into configurable pipelines.

This wheel carries the VIAME runtime and the `viame` command line tool.

## Install

```
pip install viame
```

Bring your own GPU stack: `torch` comes with the CUDA runtime this build
links against, and nothing CUDA is bundled here.

## Use

Every tool is a subcommand of `viame`. `viame help` lists them with a one
line description each, and `viame help <tool>` prints that tool's options.

```
viame help                                       # list every tool
viame run my_pipeline.pipe                       # run a single pipeline file as-is
viame run my_pipeline.pipe video.mp4             # run a pipeline on a video
viame run detector.zip video.mp4                 # run a detector on a video
viame run detector.zip image_list.txt            # ... or a list of images
viame run detector.pipe videos/                  # run a pipeline over a folder
viame train data/ train_detector.conf            # train a model on some data
viame score detections.csv groundtruth.csv       # score file against groundtruth
viame score computed/ groundtruth/               # score folder against groundtruth
viame csv detections.csv --print-types           # inspect a VIAME csv
viame json tracks.json --print-types             # inspect a DIVE or COCO json
viame add-ons                                    # list and install model add-ons
```

```python
import viame
```

## Models

The pipelines that ship are those whose models are small enough to travel
with the code. Larger models are add-on packs, fetched at runtime into the
environment alongside the shipped pipelines:

```
viame add-ons
```

## Links

* [viametoolkit.org](https://www.viametoolkit.org)
* [Source](https://github.com/VIAME/VIAME)
* [Documentation](https://viame.readthedocs.io)

BSD 3-Clause licensed.

