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

Få cardstream i gang

Én kommando på macOS og Linux; en wheel-fil fra utgivelsen, en Dockerfile og bygging fra kildekode når du vil ha mer kontroll. macOS arm64, Linux amd64 og Windows amd64 dekkes alle av den samme utgivelsen i ren Python.

Installasjonsskript

Installer med én kommando

Oppretter et virtuelt miljø i ~/.cardstream, kontrollerer wheel-filen fra utgivelsen mot sjekksummene, laster ned modellvektene og legger cardstream-web og cardstream-client på PATH. Bruker 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 opp et kort

Innstillinger, hvis du trenger dem

  • CARDSTREAM_VERSION — lås til en utgivelsestagg i stedet for den nyeste, f.eks. v0.5.2
  • CARDSTREAM_HOME — installasjonsmappen med det virtuelle miljøet og modellene (standard ~/.cardstream)
  • INSTALL_DIR — hvor startskriptene cardstream-web / cardstream-client havner (standard ~/.local/bin)
  • CARDSTREAM_MODELS_BASE_URL — en annen vert for tarballene med modellvekter, én per modell
  • CARDSTREAM_MODEL_ARCHIVES — hvilke tarballer som skal hentes derfra (atskilt med mellomrom)
  • CARDSTREAM_EXTRAS — pip-tillegg som skal installeres (standard client,onnx)
  • CARDSTREAM_TRACKER_URL — den valgfrie vitTracker-.onnx-filen (standard: OpenCV zoo)
Kontroller

Kontroller installasjonen

Skriptet kontrollerer wheel-filen mot SHA256SUMS fra utgivelsen før noe blir installert. Etterpå bekrefter ett flagg hva som ligger på maskinen din:

$ cardstream-web --version
cardstream 0.5.2

Lastet du ned filene selv? Kontroller dem på samme måte som skriptet gjør: shasum -a 256 -c SHA256SUMS.

Manuell nedlasting

Rett fra utgivelsen

Pakken ligger på PyPI, og hver utgivelse på GitHub har den samme wheel-filen og sdist ved siden av en SHA256SUMS. Én wheel-fil i ren Python dekker alle plattformer:

$ pip install 'cardstream[client,onnx]'

Windows

Installasjonsskriptet fungerer bare på POSIX-systemer. På Windows installerer du fra PyPI, pakker ut tarballene med modellvekter fra modellutgivelsen og peker flaggene mot 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

Velg din vei

Vei Best når Første kontroll
Installasjonsskript Du vil ha det raskeste oppsettet på localhost: virtuelt miljø, modellvekter og startskript på PATH ordnes for deg. cardstream-web --version
Docker En ren vertsmaskin, eller mottak av en sending fra OBS på en maskin nær koderen. curl -s http://127.0.0.1:8001/mode
Bygg fra kildekode Du endrer koden. pytest -q tests/core/test_engine.py
Docker

Kjør den i en container

Imaget laster ned modellvektene til et volum ved første oppstart og starter nettklienten. Bygg det fra Dockerfile i repoet:

$ 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 seg til 0.0.0.0 internt, så publiser porten bare på 127.0.0.1, som ovenfor. Appen har ingen autentisering og holder på API-nøkkelen din fra Ximilar; eksponer den aldri for et lokalnett eller internett.

Kildekode

Bygg fra kildekode

En utsjekk, ett skript og den frakoblede testsamlingen som første kontroll. --models laster også ned modellvektene.

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

Neste trinn

Installer og kjør →

Nøkkelen din, den første kjøringen og hva du bør sjekke.

Send inn showet ditt →

Webkameraer, henting med RTSP, OBS som sender rett inn.

Kjør den trygt →

Terskler, det anbefalte oppsettet og hvordan du holder deg på localhost.

Oppdater eller avinstaller →

Hvor skriptet legger filene, og de to kommandoene som fjerner dem igjen.