cardstream
Stažení

Zprovozněte cardstream

Na macOS a Linuxu jeden příkaz; wheel z vydání, Dockerfile a sestavení ze zdrojového kódu, když chcete mít víc pod kontrolou. macOS arm64, Linux amd64 i Windows amd64 pokrývá totéž vydání v čistém Pythonu.

Instalační skript

Instalace jedním příkazem

Vytvoří virtuální prostředí v ~/.cardstream, ověří wheel z vydání podle kontrolních součtů, stáhne váhy modelů a přidá cardstream-web a cardstream-client do PATH. Pokud máte uv, použije ho.

$ curl -fsSL https://raw.githubusercontent.com/Ximilar-com/cardstream/main/scripts/install.sh | sh
$ export XIMILAR_API_KEY=your-key
$ cardstream-web
# → http://127.0.0.1:8001 – ukažte kartu

Nastavení, pokud je potřebujete

  • CARDSTREAM_VERSION — konkrétní tag vydání místo nejnovějšího, např. v0.5.2
  • CARDSTREAM_HOME — kořen instalace s virtuálním prostředím a modely (výchozí ~/.cardstream)
  • INSTALL_DIR — kam se uloží spouštěcí skripty cardstream-web / cardstream-client (výchozí ~/.local/bin)
  • CARDSTREAM_MODELS_BASE_URL — jiný server pro archivy s váhami jednotlivých modelů
  • CARDSTREAM_MODEL_ARCHIVES — které archivy odtud stáhnout (oddělené mezerou)
  • CARDSTREAM_EXTRAS — volitelné doplňky pro pip (výchozí client,onnx)
  • CARDSTREAM_TRACKER_URL — volitelný vitTracker .onnx (výchozí: OpenCV zoo)
Ověření

Ověřte instalaci

Skript ověří wheel podle SHA256SUMS z vydání ještě předtím, než cokoli nainstaluje. Potom jeden přepínač potvrdí, co máte na počítači:

$ cardstream-web --version
cardstream 0.5.2

Stáhli jste artefakty sami? Zkontrolujte je stejně jako skript: shasum -a 256 -c SHA256SUMS.

Ruční stažení

Přímo z vydání

Balíček je na PyPI a každé vydání na GitHubu obsahuje stejný wheel a sdist spolu se souborem SHA256SUMS. Jeden wheel v čistém Pythonu pokrývá všechny platformy:

$ pip install 'cardstream[client,onnx]'

Windows

Instalační skript funguje jen v systémech POSIX; ve Windows instalujte z PyPI, rozbalte archivy s váhami jednotlivých modelů z vydání s modely a nasměrujte na ně přepínače:

> py -3.11 -m venv cardstream-env
> cardstream-env\Scripts\activate
> pip install 'cardstream[client,onnx]'
> set XIMILAR_API_KEY=your-key
> cardstream-web --segmentor-model models\segmentation_model\onnx\model.onnx ^
    --embed-model models\similarity_model\onnx\model.onnx
Srovnání

Vyberte si způsob

Způsob Nejlepší, když První ověření
Instalační skript Chcete co nejrychlejší zprovoznění na localhostu: virtuální prostředí, váhy modelů i spouštěcí skripty v PATH se vyřeší za vás. cardstream-web --version
Docker Čistý systém, nebo příjem streamu z OBS na počítači poblíž enkodéru. curl -s http://127.0.0.1:8001/mode
Ze zdrojového kódu Upravujete kód. pytest -q tests/core/test_engine.py
Docker

Spuštění v kontejneru

Obraz při prvním spuštění stáhne váhy modelů do svazku a spustí webového klienta. Sestavte ho z Dockerfile v repozitáři:

$ git clone https://github.com/Ximilar-com/cardstream && cd cardstream
$ docker build -t cardstream .
$ docker run --rm -e XIMILAR_API_KEY -p 127.0.0.1:8001:8001 \
    -v cardstream-models:/models cardstream

Kontejner uvnitř naslouchá na 0.0.0.0, port proto zveřejněte jen na 127.0.0.1, jako výše. Aplikace nemá ověřování a drží váš API klíč Ximilar; nikdy ji nezpřístupňujte do místní sítě ani do internetu.

Zdrojový kód

Sestavení ze zdrojového kódu

Klon repozitáře, jeden skript a jako první ověření offline sada testů. --models stáhne i váhy.

$ git clone https://github.com/Ximilar-com/cardstream && cd cardstream
$ ./scripts/build-from-source.sh --models
$ source .venv/bin/activate
$ cardstream-web --version