BMW-Anonymization-API 项目启动与配置教程

1. 项目目录结构及介绍

BMW-Anonymization-API 项目旨在为图像/视频中的敏感信息提供匿名化处理。以下是项目的目录结构及其说明：

• docker/: 包含 Dockerfile 以及 docker-compose 文件，用于容器化部署。
• jsonFiles/: 存放 JSON 配置文件。
• references/: 参考文献或相关资料。
• src/: 源代码目录，包含主要的程序代码。
• testing_script/: 测试脚本目录。
• url_for_openvino_compose/: OpenVINO 相关配置文件。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。

2. 项目的启动文件介绍

项目的启动主要是通过 Docker 或 docker-compose 实现的。

• Dockerfile: 用于构建项目 Docker 镜像的配置文件。
• docker-compose.yml: 定义了容器服务的组成，包括应用服务和相关环境变量配置。

启动项目时，你可以使用以下命令：

• 使用 docker-compose 启动：

docker-compose up

• 或者直接使用 docker 启动：

docker build -t anonymization_api -f docker/dockerfile .
docker run -it -p <port_of_your_choice>:4343 anonymization_api

请将 <port_of_your_choice> 替换为你希望使用的端口号。

3. 项目的配置文件介绍

项目的配置主要通过 JSON 配置文件进行。

• url_configuration.json: 存放与推断 API 连接相关的 URL 配置。
• 用户可以通过 /set_url API 端点来设置推断 API 的 URL。
• 用户可以通过 /list_urls API 端点来查看已配置的 URL 列表。
• 用户可以通过 /remove_url API 端点来删除特定的 URL。
• 用户可以通过 /remove_all_urls API 端点来删除所有的 URL。

配置文件的具体路径和内容可能根据实际项目部署的需要进行调整。

在配置项目时，确保所有依赖都已经正确安装，并且所有配置文件都按照项目要求进行了设置。这样，项目才能够顺利启动并运行。