Tải về

Đưa cardstream vào hoạt động

Một lệnh trên macOS và Linux; wheel của bản phát hành, một Dockerfile và bản build từ mã nguồn khi bạn muốn kiểm soát nhiều hơn. macOS arm64, Linux amd64 và Windows amd64 đều dùng chung một bản phát hành thuần Python.

Script cài đặt

Cài đặt bằng một lệnh

Tạo một virtualenv trong ~/.cardstream, đối chiếu wheel của bản phát hành với checksum, tải trọng số mô hình và đặt cardstream-web cùng cardstream-client lên PATH của bạn. Script dùng uv nếu máy bạn có sẵn.

$ 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 — đưa một tấm thẻ lên

Các tùy chỉnh, nếu bạn cần

CARDSTREAM_VERSION — ghim một tag phát hành thay vì bản mới nhất, ví dụ v0.5.0
CARDSTREAM_HOME — thư mục cài đặt chứa venv và các mô hình (mặc định ~/.cardstream)
INSTALL_DIR — nơi đặt các shim cardstream-web / cardstream-client (mặc định ~/.local/bin)
CARDSTREAM_MODELS_BASE_URL — máy chủ khác để tải tarball trọng số của từng mô hình
CARDSTREAM_MODEL_ARCHIVES — những tarball cần tải từ đó (cách nhau bằng dấu cách)
CARDSTREAM_EXTRAS — các extra của pip cần cài (mặc định client,onnx)
CARDSTREAM_TRACKER_URL — tệp .onnx của vitTracker tùy chọn (mặc định: OpenCV zoo)

Kiểm tra

Kiểm tra bản cài đặt

Script đối chiếu wheel với SHA256SUMS của bản phát hành trước khi cài bất cứ thứ gì. Sau đó, một cờ là đủ để xác nhận thứ đang có trên máy bạn:

$ cardstream-web --version
cardstream 0.5.0

Bạn tự tải các artifact? Hãy kiểm tra chúng đúng như cách script làm: shasum -a 256 -c SHA256SUMS.

Tải thủ công

Lấy thẳng từ bản phát hành

Gói này có trên PyPI, và mỗi bản phát hành trên GitHub đều có cùng wheel và sdist đó nằm cạnh một tệp SHA256SUMS. Một wheel thuần Python dùng được cho mọi nền tảng:

$ pip install 'cardstream[client,onnx]'

Windows

Script cài đặt chỉ chạy trên POSIX; trên Windows, hãy cài từ PyPI, giải nén tarball trọng số của từng mô hình từ bản phát hành mô hình rồi trỏ các cờ vào đó:

> 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

So sánh

Chọn cách cài

Cách cài	Phù hợp nhất khi	Bước kiểm tra đầu tiên
Script cài đặt	Bạn muốn dựng trên localhost nhanh nhất: venv, trọng số mô hình và các shim trên PATH đều được lo sẵn.	`cardstream-web --version`
Docker	Bạn muốn giữ máy chủ sạch sẽ, hoặc nhận luồng OBS đẩy sang trên một máy đặt gần encoder.	`curl -s http://127.0.0.1:8001/mode`
Build từ mã nguồn	Bạn đang sửa mã.	`pytest -q tests/core/test_engine.py`

Docker

Chạy trong container

Ở lần chạy đầu, image tải trọng số mô hình vào một volume rồi khởi động web client. Hãy build nó từ Dockerfile của 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

Bên trong, container bind vào 0.0.0.0, nên hãy publish cổng chỉ tới 127.0.0.1 như ở trên. Ứng dụng không có xác thực và đang giữ API key Ximilar của bạn; đừng bao giờ để lộ nó ra mạng LAN hay internet.

Mã nguồn

Build từ mã nguồn

Một bản checkout, một script, và bộ test chạy offline làm bước kiểm tra đầu tiên. --models tải luôn cả trọng số.

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

Đưa cardstream vào hoạt động

Cài đặt bằng một lệnh

Các tùy chỉnh, nếu bạn cần

Kiểm tra bản cài đặt

Lấy thẳng từ bản phát hành

Windows

Chọn cách cài

Chạy trong container

Build từ mã nguồn

Các bước tiếp theo

Cài đặt và chạy →

Đưa buổi live của bạn vào →

Vận hành thật vững →

Cập nhật hoặc gỡ cài đặt →