cardstream
Muat turun

Jalankan cardstream

Satu arahan pada macOS dan Linux; wheel keluaran, Dockerfile dan binaan daripada kod sumber apabila anda mahukan lebih kawalan. macOS arm64, Linux amd64 dan Windows amd64 semuanya disokong oleh keluaran Python tulen yang sama.

Skrip pemasangan

Pasang dengan satu arahan

Mencipta virtualenv dalam ~/.cardstream, mengesahkan wheel keluaran berdasarkan checksumnya, memuat turun pemberat model dan meletakkan cardstream-web serta cardstream-client dalam PATH anda. Menggunakan uv jika anda memilikinya.

$ 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 — tunjukkan sekeping kad

Tetapan tambahan, jika anda memerlukannya

  • CARDSTREAM_VERSION — tetapkan tag keluaran tertentu dan bukan yang terkini, contohnya v0.5.2
  • CARDSTREAM_HOME — direktori akar pemasangan yang menyimpan venv dan model (lalai ~/.cardstream)
  • INSTALL_DIR — tempat shim cardstream-web / cardstream-client diletakkan (lalai ~/.local/bin)
  • CARDSTREAM_MODELS_BASE_URL — hos alternatif untuk tarball pemberat setiap model
  • CARDSTREAM_MODEL_ARCHIVES — tarball yang hendak dimuat turun dari situ (dipisahkan dengan ruang)
  • CARDSTREAM_EXTRAS — tambahan pip yang hendak dipasang (lalai client,onnx)
  • CARDSTREAM_TRACKER_URL — vitTracker .onnx pilihan (lalai: zoo OpenCV)
Sahkan

Sahkan pemasangan

Skrip mengesahkan wheel berdasarkan SHA256SUMS keluaran itu sebelum memasang apa-apa. Selepas itu, satu bendera mengesahkan apa yang ada pada mesin anda:

$ cardstream-web --version
cardstream 0.5.2

Muat turun artifak sendiri? Semaknya dengan cara yang sama seperti skrip: shasum -a 256 -c SHA256SUMS.

Muat turun manual

Terus daripada keluaran

Pakej ini ada di PyPI, dan setiap keluaran GitHub membawa wheel dan sdist yang sama bersama SHA256SUMS. Satu wheel Python tulen meliputi setiap platform:

$ pip install 'cardstream[client,onnx]'

Windows

Skrip pemasangan hanya untuk POSIX; pada Windows, pasang dari PyPI, nyahmampat tarball pemberat setiap model daripada keluaran model, dan halakan bendera kepadanya:

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

Pilih cara anda

Cara Paling sesuai apabila Pengesahan pertama
Skrip pemasangan Anda mahukan persediaan localhost yang paling pantas: venv, pemberat model dan shim PATH diuruskan untuk anda. cardstream-web --version
Docker Hos yang bersih, atau menerima tolakan OBS pada mesin berhampiran pengekod. curl -s http://127.0.0.1:8001/mode
Bina daripada kod sumber Anda sedang mengubah kod. pytest -q tests/core/test_engine.py
Docker

Jalankan dalam bekas

Imej ini memuat turun pemberat model ke dalam satu volum pada larian pertama dan memulakan klien web. Binanya daripada Dockerfile dalam repositori:

$ 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

Bekas ini mengikat 0.0.0.0 secara dalaman. Terbitkan port itu kepada 127.0.0.1 sahaja, seperti di atas. Aplikasi ini tidak memerlukan pengesahan dan menyimpan kunci API Ximilar anda; jangan sekali-kali dedahkannya kepada LAN atau internet.

Kod sumber

Bina daripada kod sumber

Satu checkout, satu skrip, dan suite ujian luar talian sebagai pengesahan pertama anda. --models turut memuat turun pemberat.

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