Jalankan cardstream
Satu perintah di macOS dan Linux; wheel rilis, Dockerfile, dan build dari kode sumber kalau kamu ingin kendali lebih. macOS arm64, Linux amd64, dan Windows amd64 semuanya tercakup oleh rilis pure-Python yang sama.
Instal dengan satu perintah
Membuat virtualenv di ~/.cardstream, memverifikasi wheel rilis dengan checksum-nya, mengunduh bobot model, dan menaruh cardstream-web serta cardstream-client di PATH-mu. Memakai uv kalau kamu sudah punya.
$ 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 — angkat sebuah kartu
Pengatur, kalau kamu membutuhkannya
-
CARDSTREAM_VERSION— mengunci tag rilis tertentu alih-alih yang terbaru, mis. v0.5.0 -
CARDSTREAM_HOME— direktori instalasi yang berisi venv dan model (bawaan ~/.cardstream) -
INSTALL_DIR— tempat shim cardstream-web / cardstream-client ditaruh (bawaan ~/.local/bin) -
CARDSTREAM_MODELS_BASE_URL— host alternatif untuk tarball bobot per model -
CARDSTREAM_MODEL_ARCHIVES— tarball mana yang diunduh dari sana (dipisahkan spasi) -
CARDSTREAM_EXTRAS— extras pip yang diinstal (bawaan client,onnx) -
CARDSTREAM_TRACKER_URL— file .onnx vitTracker yang opsional (bawaan: OpenCV zoo)
Verifikasi instalasinya
Skripnya memverifikasi wheel dengan SHA256SUMS milik rilis sebelum menginstal apa pun. Setelah itu, satu flag memastikan apa yang ada di komputermu:
$ cardstream-web --version
cardstream 0.5.0 Mengunduh artefaknya sendiri? Periksa dengan cara yang sama seperti skripnya: shasum -a 256 -c SHA256SUMS.
Langsung dari rilis
Paketnya ada di PyPI, dan setiap rilis GitHub membawa wheel dan sdist yang sama di samping sebuah SHA256SUMS. Satu wheel pure-Python mencakup semua platform:
$ pip install 'cardstream[client,onnx]' Windows
Skrip instalasinya hanya untuk POSIX. Di Windows, instal dari PyPI, ekstrak tarball bobot per model dari rilis model, lalu arahkan flag-nya ke sana:
> 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
Pilih caramu
| Cara | Paling cocok kalau | Verifikasi pertama |
|---|---|---|
| Skrip instalasi | Kamu ingin penyiapan localhost yang paling cepat: venv, bobot model, dan shim di PATH diurus untukmu. | cardstream-web --version |
| Docker | Host yang bersih, atau menerima kiriman OBS di komputer dekat encoder. | curl -s http://127.0.0.1:8001/mode |
| Build dari kode sumber | Kamu sedang mengubah kodenya. | pytest -q tests/core/test_engine.py |
Jalankan di dalam container
Image-nya mengunduh bobot model ke sebuah volume saat pertama kali dijalankan, lalu memulai klien web. Build dari Dockerfile di repo:
$ 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
Container mengikat 0.0.0.0 secara internal. Publikasikan port-nya hanya ke 127.0.0.1, seperti di atas. Aplikasinya tanpa autentikasi dan memegang kunci API Ximilar-mu; jangan pernah membukanya ke LAN atau internet.
Build dari kode sumber
Sebuah checkout, satu skrip, dan rangkaian pengujian offline sebagai verifikasi pertamamu. --models sekaligus mengunduh bobotnya.
$ git clone https://github.com/Ximilar-com/cardstream && cd cardstream $ ./scripts/build-from-source.sh --models $ source .venv/bin/activate $ cardstream-web --version
Langkah berikutnya
Instal dan jalankan →
Kuncimu, saat pertama kali menjalankan, dan apa yang perlu diperiksa.
Beri ia live-mu →
Webcam, tarikan RTSP, OBS yang mengirim langsung.
Jalankan dengan tenang →
Ambang batas, cara menjalankan yang disarankan, dan tetap di localhost.
Perbarui atau hapus →
Di mana skrip menaruh semuanya, dan dua perintah yang membatalkannya.