English 
Español 
日本語 
한국어 
简体中文 
ไทย 
Português 
Français 
Italiano 
Deutsch 
हिन्दी 
বাংলা 
پنجابی 
Dansk 
Svenska 
Polski 
العربية 
Tiếng Việt 
Türkçe 
Nederlands 
Bahasa Indonesia Запустите cardstream
Одна команда на macOS и Linux, а если нужно больше контроля — релизный wheel, Dockerfile и сборка из исходников. Один и тот же релиз на чистом Python подходит для macOS arm64, Linux amd64 и Windows amd64.
Установка одной командой
Создаёт виртуальное окружение в ~/.cardstream, сверяет релизный wheel с контрольными суммами, скачивает веса моделей и добавляет 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— другой хост для архивов с весами моделей -
CARDSTREAM_MODEL_ARCHIVES— какие архивы оттуда скачивать (через пробел) -
CARDSTREAM_EXTRAS— какие extras ставить через pip (по умолчанию client,onnx) -
CARDSTREAM_TRACKER_URL— необязательный vitTracker в формате .onnx (по умолчанию из 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, распакуйте архивы с весами моделей из релиза с моделями и укажите пути к ним во флагах:
> 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
Внутри контейнер слушает 0.0.0.0, поэтому публикуйте порт только на 127.0.0.1, как в примере выше. Приложение работает без авторизации и хранит ваш API-ключ Ximilar: никогда не открывайте доступ к нему из локальной сети или интернета.
Сборка из исходников
Клон репозитория, один скрипт и офлайн-тесты в качестве первой проверки. С флагом --models скачиваются и веса.
$ git clone https://github.com/Ximilar-com/cardstream && cd cardstream $ ./scripts/build-from-source.sh --models $ source .venv/bin/activate $ cardstream-web --version