Skip to main content

VAME App

PyPI version

A web application for the Variational Animal Motion Encoding (VAME) project — an open-source machine learning tool for behavioral segmentation and analyses.

VAME App runs a Python (Flask) backend which calls the VAME library and serves a React frontend, which you use in your browser.

VAME App

Requirements

  • Python ≥ 3.12
  • ffmpeg (needed for some video/image functions)
  • A modern browser (Chrome, Edge, Firefox, or Safari)

Install

pip install vame-app

If PyTorch fails to install for your platform, install it first following the official instructions, then re-run pip install vame-app.

Run

vame-app

This starts the local server and opens the app in your browser.

CLI options

vame-app [--host HOST] [--port PORT] [--data-root DIR] [--no-browser] [--dev]
Flag Default Purpose
--host 127.0.0.1 Interface to bind. Use 0.0.0.0 to expose on the LAN.
--port 8641 Port to listen on. Use 0 to auto-pick a free port.
--data-root home directory Root the in-app file browser may traverse. Restrict this on shared servers.
--no-browser off Don't auto-open the browser.
--dev off Use the Flask dev server instead of waitress.

Projects are stored under ~/vame-app/projects. --data-root (env VAME_DATA_ROOT) only controls the file browser root, not project storage.

Development

Contributing or running from source? See README-DEV.md.

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

vame_app-0.4.3-py3-none-any.whl (2.5 MB view details)

Uploaded Python 3

File details

Details for the file vame_app-0.4.3-py3-none-any.whl.

File metadata

  • Download URL: vame_app-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 2.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for vame_app-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 cecc68fbd9fe459b14556248edbae55d29478f0a68f6a32f76efd34e783c8fbc
MD5 5c47032fde7f7450734e15492bc4a824
BLAKE2b-256 75dee5530cb738789076c7da42421941c11cdde7c1e6a09858ae20b14e8c22bf

See more details on using hashes here.

Provenance

The following attestation bundles were made for vame_app-0.4.3-py3-none-any.whl:

Publisher: build_and_publish.yml on EthoML/vame-app

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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