Ladda ner

Få igång cardstream

Ett kommando på macOS och Linux; releasens wheel, en Dockerfile och ett bygge från källkod när du vill ha mer kontroll. macOS arm64, Linux amd64 och Windows amd64 täcks alla av samma release i ren Python.

Installationsskript

Installera med ett kommando

Skapar en virtualenv i ~/.cardstream, verifierar releasens wheel mot kontrollsummorna, hämtar modellvikterna och lägger cardstream-web och cardstream-client i din PATH. Använder uv om 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 (håll upp ett kort)

Reglage, om du behöver dem

CARDSTREAM_VERSION — lås till en releasetagg i stället för den senaste, t.ex. v0.5.0
CARDSTREAM_HOME — installationsrot med venv och modeller (standard ~/.cardstream)
INSTALL_DIR — där shim-skripten cardstream-web / cardstream-client hamnar (standard ~/.local/bin)
CARDSTREAM_MODELS_BASE_URL — alternativ värd för tar-arkiven med vikter, ett per modell
CARDSTREAM_MODEL_ARCHIVES — vilka tar-arkiv som ska hämtas därifrån (avgränsade med mellanslag)
CARDSTREAM_EXTRAS — pip-extras som ska installeras (standard client,onnx)
CARDSTREAM_TRACKER_URL — den valfria vitTracker-filen .onnx (standard: OpenCV zoo)

Verifiera

Verifiera installationen

Skriptet verifierar wheel-filen mot releasens SHA256SUMS innan något installeras. Efteråt bekräftar en flagga vad som finns på din dator:

$ cardstream-web --version
cardstream 0.5.0

Har du laddat ner artefakterna själv? Kontrollera dem på samma sätt som skriptet gör: shasum -a 256 -c SHA256SUMS.

Manuell nedladdning

Direkt från releasen

Paketet finns på PyPI, och varje GitHub-release har samma wheel och sdist bredvid en SHA256SUMS. En enda wheel i ren Python täcker alla plattformar:

$ pip install 'cardstream[client,onnx]'

Windows

Installationsskriptet fungerar bara i POSIX-miljöer. På Windows installerar du från PyPI, packar upp tar-arkiven med vikter (ett per modell) från modellreleasen och pekar flaggorna 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

Jämför

Välj väg

Väg	Passar bäst när	Första kontrollen
Installationsskript	Du vill komma igång så snabbt som möjligt på localhost: venv, modellvikter och shim-skript i PATH ordnas åt dig.	`cardstream-web --version`
Docker	En ren värddator, eller när du tar emot det OBS skickar på en dator nära kodaren.	`curl -s http://127.0.0.1:8001/mode`
Bygg från källkod	Du ändrar i koden.	`pytest -q tests/core/test_engine.py`

Docker

Kör det i en container

Imagen hämtar modellvikterna till en volym vid första körningen och startar webbklienten. Bygg den från repots 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

Containern binder 0.0.0.0 internt, så publicera porten enbart mot 127.0.0.1, som ovan. Appen saknar inloggning och har din API-nyckel från Ximilar; exponera den aldrig mot ett LAN eller internet.

Källkod

Bygg från källkod

Ett klonat repo och ett skript, med testsviten (som körs offline) som första kontroll. --models hämtar också vikterna.

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

Få igång cardstream

Installera med ett kommando

Reglage, om du behöver dem

Verifiera installationen

Direkt från releasen

Windows

Välj väg

Kör det i en container

Bygg från källkod

Nästa steg

Installera och kör →

Mata det med din sändning →

Drift du kan lita på →

Uppdatera eller avinstallera →