ทำให้ cardstream ทำงาน
คำสั่งเดียวบน macOS และ Linux หรือใช้ wheel ของรีลีส Dockerfile และการบิลด์จากซอร์สเมื่อคุณต้องการควบคุมมากขึ้น macOS arm64, Linux amd64 และ Windows amd64 ครอบคลุมด้วยรีลีส Python ล้วนตัวเดียวกัน
ติดตั้งด้วยคำสั่งเดียว
สร้าง virtualenv ใน ~/.cardstream ตรวจสอบ wheel ของรีลีสกับ checksum ดาวน์โหลดน้ำหนักโมเดล และวาง cardstream-web กับ cardstream-client บน PATH ของคุณ ใช้ uv ถ้าคุณมี
$ 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 — ยกการ์ดขึ้นมาให้กล้องเห็น
ตัวเลือกปรับแต่ง หากต้องการ
-
CARDSTREAM_VERSION— ล็อกแท็กรีลีสแทนเวอร์ชันล่าสุด เช่น v0.5.0 -
CARDSTREAM_HOME— รูทของการติดตั้งที่เก็บ venv และโมเดล (ค่าเริ่มต้น ~/.cardstream) -
INSTALL_DIR— ที่วางสคริปต์เรียกใช้ cardstream-web / cardstream-client (ค่าเริ่มต้น ~/.local/bin) -
CARDSTREAM_MODELS_BASE_URL— โฮสต์สำรองสำหรับ tarball น้ำหนักของแต่ละโมเดล -
CARDSTREAM_MODEL_ARCHIVES— จะดึง tarball ตัวไหนบ้างจากที่นั่น (คั่นด้วยช่องว่าง) -
CARDSTREAM_EXTRAS— pip extras ที่จะติดตั้ง (ค่าเริ่มต้น client,onnx) -
CARDSTREAM_TRACKER_URL— ไฟล์ .onnx ของ vitTracker แบบเลือกใช้ (ค่าเริ่มต้น: OpenCV zoo)
ตรวจสอบการติดตั้ง
สคริปต์ตรวจสอบ wheel กับ SHA256SUMS ของรีลีสก่อนติดตั้งอะไรทั้งนั้น หลังจากนั้น แฟล็กเดียวยืนยันได้ว่าบนเครื่องคุณมีอะไร:
$ cardstream-web --version
cardstream 0.5.0 ดาวน์โหลดอาร์ทิแฟกต์มาเอง? ตรวจสอบแบบเดียวกับที่สคริปต์ทำ: shasum -a 256 -c SHA256SUMS
ตรงจากรีลีส
แพ็กเกจอยู่บน PyPI และทุกรีลีสบน GitHub มี wheel และ sdist ตัวเดียวกันวางคู่กับ SHA256SUMS wheel Python ล้วนตัวเดียวครอบคลุมทุกแพลตฟอร์ม:
$ pip install 'cardstream[client,onnx]' Windows
สคริปต์ติดตั้งรองรับเฉพาะ POSIX บน Windows ให้ติดตั้งจาก PyPI แตก tarball น้ำหนักของแต่ละโมเดลจากรีลีสโมเดล แล้วชี้แฟล็กไปที่ไฟล์เหล่านั้น:
> 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
เลือกวิธีของคุณ
| วิธี | เหมาะเมื่อ | การตรวจสอบครั้งแรก |
|---|---|---|
| สคริปต์ติดตั้ง | คุณต้องการตั้งค่า localhost ให้เร็วที่สุด ทั้ง venv น้ำหนักโมเดล และสคริปต์เรียกใช้บน PATH จัดการให้หมด | cardstream-web --version |
| Docker | โฮสต์ที่สะอาด หรือรับพุชจาก OBS บนเครื่องใกล้เอนโค้ดเดอร์ | curl -s http://127.0.0.1:8001/mode |
| บิลด์จากซอร์ส | คุณกำลังแก้โค้ด | pytest -q tests/core/test_engine.py |
รันในคอนเทนเนอร์
อิมเมจดึงน้ำหนักโมเดลลงโวลุมตอนรันครั้งแรก แล้วเริ่มเว็บไคลเอนต์ บิลด์จาก 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
ภายในคอนเทนเนอร์ bind กับ 0.0.0.0 ดังนั้นให้เผยแพร่พอร์ตไปที่ 127.0.0.1 เท่านั้น ตามตัวอย่างข้างบน แอปไม่มีการยืนยันตัวตนและถือคีย์ Ximilar API ของคุณอยู่ อย่าเปิดสู่ LAN หรืออินเทอร์เน็ตเด็ดขาด
บิลด์จากซอร์ส
เช็กเอาต์ รันสคริปต์หนึ่งตัว แล้วใช้ชุดทดสอบออฟไลน์เป็นการตรวจสอบครั้งแรก --models จะดึงน้ำหนักโมเดลมาด้วย
$ git clone https://github.com/Ximilar-com/cardstream && cd cardstream $ ./scripts/build-from-source.sh --models $ source .venv/bin/activate $ cardstream-web --version