NekoImageGallery下載 - NekoImageGallery原始碼下載

NekoImageGallery

其他源碼

v1.3.0

下載

Neko圖片庫

基於Clip模型和Qdrant向量資料庫的線上AI影像搜尋引擎。支援關鍵字搜尋和相似圖片搜尋。

中文文檔

特徵

使用Clip模型為每張影像產生768維向量作為搜尋的基礎。無需手動標註或分類，無限分類類別。
支援OCR文字搜索，使用PaddleOCR從圖像中提取文字並使用BERT生成文字向量進行搜尋。
使用 Qdrant 向量資料庫進行高效率的向量搜尋。

?截圖

截圖1 截圖2 截圖3 截圖4 截圖5 截圖6

以上截圖可能包含來自不同藝術家的版權圖像，請勿將其用於其他目的。

✈️部署

本地部署

選擇元資料儲存方法

Qdrant 資料庫（建議）

在大多數情況下，我們建議使用 Qdrant 資料庫來儲存元資料。 Qdrant資料庫提供高效的檢索效能、靈活的可擴展性和更好的資料安全性。

請根據Qdrant文件部署Qdrant資料庫。建議使用Docker進行部署。

如果您不想自行部署Qdrant，可以使用Qdrant提供的線上服務。

本地文件存儲

本機檔案儲存直接將影像元資料（包括特徵向量等）儲存在本機SQLite資料庫中。僅建議用於小規模部署或開發部署。

本機檔案儲存不需要額外的資料庫部署流程，但有以下缺點：

本機儲存不會索引和最佳化向量，因此所有搜尋的時間複雜度為O(n) 。因此，如果資料規模較大，搜尋和索引的效能就會下降。
使用本機檔案儲存將使 NekoImageGallery 有狀態，因此它將失去水平可擴展性。
當您想要遷移到Qdrant資料庫進行儲存時，索引的元資料可能很難直接遷移。

部署 NekoImageGallery

將專案目錄複製到您自己的 PC 或伺服器，然後簽出到特定版本標籤（例如v1.0.0 ）。
強烈建議在Python venv虛擬環境中安裝該專案所需的依賴項。運行以下命令：
```
python -m venv .venv
. .venv/bin/activate
```
安裝 PyTorch。依照 PyTorch 文件使用 pip 安裝適合您系統的 torch 版本。
如果您想使用 CUDA 加速進行推理，請務必在此步驟中安裝支援 CUDA 的 PyTorch 版本。安裝完成後，可以使用torch.cuda.is_available()來確認CUDA是否可用。
安裝該項目所需的其他依賴項：
```
pip install -r requirements.txt
```
修改config/中的專案設定文件，可以直接編輯default.env ，但建議建立一個名為local.env的新檔案並覆寫default.env中的設定。
運行這個應用程式：
```
python main.py
```
您可以使用--host指定要綁定的 IP 位址（預設為 0.0.0.0），使用--port指定要綁定的連接埠（預設為 8000）。
您可以透過執行python main.py --help來查看所有可用的命令和選項。
（可選）部署前端應用程式：NekoImageGallery.App 是該專案的一個簡單的 Web 前端應用程式。如果您想部署它，請參考它的部署文件。

？ Docker部署

關於 docker 映像

NekoImageGallery 的 docker 映像像是在 Docker Hub 上建置和發布的，包括幾種變體：

標籤	描述	最新影像尺寸
`edgeneko/neko-image-gallery:<version>` `edgeneko/neko-image-gallery:<version>-cuda` `edgeneko/neko-image-gallery:<version>-cuda12.1`	支援使用 CUDA12.1 進行 GPU 推理
`edgeneko/neko-image-gallery:<version>-cuda11.8`	支援使用 CUDA11.8 進行 GPU 推理
`edgeneko/neko-image-gallery:<version>-cpu`	僅支援CPU推理

其中<version>是NekoImageGallery的版本號碼或版本別名，如下：

版本	描述
`latest`	NekoImageGallery 最新穩定版本
`v..` / `v.*`	具體版本號（對應Git標籤）
`edge`	NekoImageGallery 的最新開發版本可能包含不穩定的功能和重大更改

在每個影像中，我們捆綁了必要的依賴項、 openai/clip-vit-large-patch14模型權重、 bert-base-chinese模型權重和easy-paddle-ocr模型，以提供完整且隨時可用的影像。

圖像使用/opt/NekoImageGallery/static作為儲存圖像檔案的捲，如果需要本地存儲，請將其安裝到您自己的捲或目錄。

對於配置，我們建議使用環境變數來覆蓋預設配置。秘密（如 API 令牌）可以由 docker 秘密提供。

準備好`nvidia-container-runtime` （僅限 CUDA 使用者）

如果要使用 CUDA 加速，則需要在系統上安裝nvidia-container-runtime 。安裝請參考官方文件。

相關文件：
https://docs.docker.com/config/containers/resource_constraints/#gpu
https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#docker
https://nvidia.github.io/nvidia-container-runtime/

運行伺服器

從儲存庫下載docker-compose.yml檔案。

 # For cuda deployment (default)
wget https://raw.githubusercontent.com/hv0905/NekoImageGallery/master/docker-compose.yml
# For CPU-only deployment
wget https://raw.githubusercontent.com/hv0905/NekoImageGallery/master/docker-compose-cpu.yml && mv docker-compose-cpu.yml docker-compose.yml

根據需要修改 docker-compose.yml 文件

執行以下命令啟動伺服器：

 # start in foreground
docker compose up
# start in background(detached mode)
docker compose up -d

將圖像上傳到 NekoImageGallery

有多種方法可以將圖像上傳到 NekoImageGallery

透過Web介面：您可以使用Web介面將圖像上傳到伺服器。 Web 介面由 NekoImageGallery.App 提供。確保您已啟用管理 API並在設定檔中設定管理令牌。
透過本機索引：適合本機部署或當您要上傳的映像已經在伺服器上時。使用以下命令來索引本地圖像目錄：
```
 python main.py local-index < path-to-your-image-directory >
```
上面的指令會遞歸地將指定目錄及其子目錄中的所有圖片上傳到伺服器。您也可以為上傳的圖像指定類別/加星標，請參閱python main.py local-index --help了解更多資訊。
透過API：您可以使用NekoImageGallery提供的上傳API來上傳圖片。透過使用此方法，伺服器可以防止將映像檔保存在本地，而只儲存其 URL 和元資料。
確保您已啟用管理 API並在設定檔中設定管理令牌。
此方法適用於自動圖像上傳或與外部系統同步NekoImageGallery。查看 API 文件以取得更多資訊。