cardstream
GitHub Kom i gang
Sprog: Dansk
English Español 日本語 한국어 简体中文 ไทย Português Français Italiano Deutsch हिन्दी বাংলা پنجابی Dansk Svenska Polski Русский اردو العربية Tiếng Việt Türkçe Nederlands Bahasa Indonesia
Download

Få cardstream op at køre

Én kommando på macOS og Linux. Vil du have mere kontrol, er der et release-wheel, en Dockerfile og et build fra kildekoden. macOS arm64, Linux amd64 og Windows amd64 dækkes alle af den samme release i ren Python.

Installationsscript

Installer med én kommando

Opretter et virtualenv i ~/.cardstream, kontrollerer releasens wheel mod dens kontrolsummer, henter modelvægtene og lægger cardstream-web og cardstream-client på din PATH. Bruger uv, hvis du har det.

$ 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 (hold et kort op)

Knapper at skrue på, hvis du får brug for dem

  • CARDSTREAM_VERSION — lås til et bestemt release-tag i stedet for det nyeste, f.eks. v0.5.0
  • CARDSTREAM_HOME — installationsrod med venv og modeller (standard ~/.cardstream)
  • INSTALL_DIR — hvor shims til cardstream-web / cardstream-client lægges (standard ~/.local/bin)
  • CARDSTREAM_MODELS_BASE_URL — alternativ vært for tarballs med vægte pr. model
  • CARDSTREAM_MODEL_ARCHIVES — hvilke tarballs der skal hentes derfra (adskilt af mellemrum)
  • CARDSTREAM_EXTRAS — pip-extras, der skal installeres (standard client,onnx)
  • CARDSTREAM_TRACKER_URL — den valgfrie vitTracker .onnx (standard: OpenCV zoo)
Kontrol

Kontroller installationen

Scriptet kontrollerer wheel-filen mod releasens SHA256SUMS, før det installerer noget. Bagefter bekræfter ét flag, hvad der ligger på din computer:

$ cardstream-web --version
cardstream 0.5.0

Har du selv hentet artefakterne? Tjek dem på samme måde, som scriptet gør: shasum -a 256 -c SHA256SUMS.

Manuel download

Direkte fra releasen

Pakken ligger på PyPI, og hver GitHub-release har samme wheel og sdist ved siden af en SHA256SUMS. Én wheel-fil i ren Python dækker alle platforme:

$ pip install 'cardstream[client,onnx]'

Windows

Installationsscriptet er kun til POSIX. På Windows installerer du fra PyPI, pakker tarballs med vægtene pr. model ud fra modelreleasen og peger flagene på dem:

> 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
Sammenlign

Vælg din metode

Metode Bedst, når Første kontrol
Installationsscript Du vil have den hurtigste opsætning på localhost: venv, modelvægte og shims på PATH bliver klaret for dig. cardstream-web --version
Docker Du har en ren vært eller vil modtage et push fra OBS på en maskine tæt på encoderen. curl -s http://127.0.0.1:8001/mode
Byg fra kildekode Du ændrer i koden. pytest -q tests/core/test_engine.py
Docker

Kør det i en container

Imaget henter modelvægtene til et volume ved første kørsel og starter webklienten. Byg det fra repoets Dockerfile:

$ 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

Containeren binder internt til 0.0.0.0, så udgiv kun porten på 127.0.0.1 som ovenfor. Appen har ingen adgangskontrol og ligger inde med din API-nøgle til Ximilar. Åbn den aldrig mod et lokalnetværk eller internettet.

Kildekode

Byg fra kildekode

Et checkout, ét script og den offline testpakke som din første kontrol. --models henter også vægtene.

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

Næste skridt

Installer og kør →

Din nøgle, din første kørsel, og hvad du skal tjekke.

Giv det dit show →

Webcams, RTSP-pulls og OBS, der sender direkte ind.

Kør det med ro i maven →

Tærskler, den anbefalede kørsel og at blive på localhost.

Opdater eller afinstaller →

Hvor scriptet lægger tingene, og de to kommandoer, der fjerner det igen.