Pobieranie

Uruchom cardstream u siebie

Jedno polecenie w systemach macOS i Linux. Wheel z wydania, Dockerfile i budowanie ze źródeł, gdy chcesz mieć większą kontrolę. Systemy macOS arm64, Linux amd64 i Windows amd64 obsługuje to samo wydanie pure-Python.

Skrypt instalacyjny

Instalacja jednym poleceniem

Tworzy virtualenv w ~/.cardstream, sprawdza wheel z wydania względem sum kontrolnych, pobiera wagi modeli i umieszcza cardstream-web oraz cardstream-client w Twoim PATH. Jeśli masz uv, skorzysta z niego.

$ 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 (pokaż kartę do kamery)

Ustawienia, gdyby były potrzebne

CARDSTREAM_VERSION — przypina konkretny tag wydania zamiast najnowszego, np. v0.5.0
CARDSTREAM_HOME — katalog instalacji z venv i modelami (domyślnie ~/.cardstream)
INSTALL_DIR — miejsce na shimy cardstream-web / cardstream-client (domyślnie ~/.local/bin)
CARDSTREAM_MODELS_BASE_URL — inny serwer z archiwami wag poszczególnych modeli
CARDSTREAM_MODEL_ARCHIVES — które archiwa stamtąd pobrać (rozdzielone spacjami)
CARDSTREAM_EXTRAS — dodatki (extras) instalowane przez pip (domyślnie client,onnx)
CARDSTREAM_TRACKER_URL — opcjonalny vitTracker .onnx (domyślnie: OpenCV zoo)

Weryfikacja

Sprawdź instalację

Zanim skrypt cokolwiek zainstaluje, sprawdza wheel względem pliku SHA256SUMS z wydania. Potem jedna flaga potwierdza, co masz na komputerze:

$ cardstream-web --version
cardstream 0.5.0

Pobierasz pliki samodzielnie? Sprawdź je tak samo, jak robi to skrypt: shasum -a 256 -c SHA256SUMS.

Pobieranie ręczne

Prosto z wydania

Pakiet jest w PyPI, a każde wydanie w serwisie GitHub zawiera ten sam wheel i sdist obok pliku SHA256SUMS. Jeden wheel pure-Python obsługuje wszystkie platformy:

$ pip install 'cardstream[client,onnx]'

Windows

Skrypt instalacyjny działa tylko w systemach POSIX. W systemie Windows zainstaluj pakiet z PyPI, rozpakuj archiwa z wagami poszczególnych modeli z wydania z modelami i wskaż je flagami:

> 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

Porównanie

Wybierz sposób

Sposób	Najlepszy, gdy	Pierwsze sprawdzenie
Skrypt instalacyjny	Chcesz najszybciej uruchomić wszystko na localhost: venv, wagi modeli i shimy w PATH robią się same.	`cardstream-web --version`
Docker	Masz czysty host albo odbierasz stream wysyłany z OBS na komputerze blisko enkodera.	`curl -s http://127.0.0.1:8001/mode`
Budowanie ze źródeł	Zmieniasz kod.	`pytest -q tests/core/test_engine.py`

Docker

Uruchom w kontenerze

Przy pierwszym uruchomieniu obraz pobiera wagi modeli na wolumin i uruchamia klienta webowego. Zbuduj go z pliku Dockerfile w repozytorium:

$ 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

Kontener nasłuchuje wewnątrz na 0.0.0.0, więc publikuj port wyłącznie na 127.0.0.1, tak jak wyżej. Aplikacja nie wymaga uwierzytelniania i przechowuje Twój klucz API Ximilar. Nigdy nie wystawiaj jej do sieci LAN ani do internetu.

Źródła

Budowanie ze źródeł

Sklonowane repozytorium, jeden skrypt i zestaw testów offline jako pierwsze sprawdzenie. Flaga --models pobiera też wagi.

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

Uruchom cardstream u siebie

Instalacja jednym poleceniem

Ustawienia, gdyby były potrzebne

Sprawdź instalację

Prosto z wydania

Windows

Wybierz sposób

Uruchom w kontenerze

Budowanie ze źródeł

Co dalej

Instalacja i uruchomienie →

Podaj mu swoją transmisję →

Działaj pewnie →

Aktualizacja lub odinstalowanie →