---

(2020年1月) Luminoth 已不再维护。我们建议切换到 Facebook 的 Detectron2，它实现了更现代的算法，并支持更多用例。

---

Luminoth 是一个用于 计算机视觉 的开源工具包。目前我们支持目标检测，但我们的目标是实现更多功能。它基于 Python 构建，使用了 TensorFlow 和 Sonnet。

完整的文档请参阅 这里。

免责声明：Luminoth 仍处于 Alpha 阶段，这意味着随着代码库的不断完善，内部和外部接口（例如命令行界面）很可能会发生变化。

安装

Luminoth 目前支持 Python 2.7 和 3.4–3.6。

先决条件

要使用 Luminoth，必须先安装 TensorFlow。如果您需要 GPU 支持，请使用 pip install tensorflow-gpu 安装 GPU 版本的 TensorFlow；否则可以使用 pip install tensorflow 安装 CPU 版本。

安装 Luminoth

只需从 PyPI 安装即可：

pip install luminoth

可选地，您也可以通过运行 pip install luminoth[tf] 或 pip install luminoth[tf-gpu] 来让 Luminoth 自动为您安装 TensorFlow，具体取决于您希望使用的 TensorFlow 版本。

Google Cloud

如果您希望使用 Google Cloud ML Engine 进行训练，则需要安装可选依赖项：

pip install luminoth[gcloud]

从源码安装

首先在您的机器上克隆仓库，然后使用 pip 安装：

git clone https://github.com/tryolabs/luminoth.git
cd luminoth
pip install -e .

检查安装是否成功

只需运行 lumi --help 即可。

支持的模型

目前我们支持以下模型：

• 目标检测
  • Faster R-CNN
  • SSD

我们计划在不久的将来添加对更多模型的支持，例如 RetinaNet 和 Mask R-CNN。

我们还提供了上述模型的 预训练检查点，这些检查点是在流行的 数据集 上训练得到的，例如 COCO 和 Pascal。

使用方法

有一个主要的命令行界面，可以通过 lumi 命令使用。当您不确定如何操作时，只需输入：

lumi --help 或 lumi <子命令> --help

就会显示可用选项及其描述列表。

处理数据集

请参阅 适配数据集。

训练

请参阅 训练您自己的模型，了解如何在本地或 Google Cloud 中进行训练。

可视化结果

我们致力于生成有用且易于理解的摘要和图表可视化。我们认为这些不仅对于监控至关重要（当然如此！），而且有助于更全面地理解系统内部的工作原理。就像代码需要清晰易懂一样，计算图也应该同样直观易读。

默认情况下，摘要和图日志会保存在当前目录下的 jobs/ 文件夹中。您可以使用 TensorBoard 查看这些日志，运行以下命令：

tensorboard --logdir path/to/jobs

为什么叫这个名字？

黑暗面罩是《银河战士Prime 2：回音》中的面罩升级版。它由 卢米诺斯族 在战争期间设计，曾被以太界的冠军 A-Kul 用来穿透黑暗以太界的迷雾，与英格族作战。

—— 黑暗面罩 - Wikitroid

许可证

版权所有 © 2018, Tryolabs。 根据 BSD 3-Clause 许可证发布。

Luminoth 快速上手指南

⚠️ 重要提示：Luminoth 项目已于 2020 年 1 月停止维护。官方建议开发者迁移至 Facebook 的 Detectron2，后者支持更现代的算法和更多应用场景。本指南仅供学习参考或维护旧项目使用。

Luminoth 是一个基于 Python、TensorFlow 和 Sonnet 构建的开源计算机视觉工具包，主要支持目标检测任务（如 Faster R-CNN 和 SSD）。

环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统：Linux 或 macOS（Windows 支持有限，建议使用 WSL）
• Python 版本：2.7 或 3.4 – 3.6
• 前置依赖：必须预先安装 TensorFlow。
  • CPU 版本：pip install tensorflow
  • GPU 版本（推荐）：pip install tensorflow-gpu
  • 国内加速建议：如遇下载缓慢，可使用清华源：pip install -i https://pypi.tuna.tsinghua.edu.cn/simple tensorflow-gpu

安装步骤

您可以通过 PyPI 直接安装，也可以从源码安装。

方式一：通过 PyPI 安装（推荐）

直接安装 Luminoth：

pip install luminoth

如果您希望 pip 自动处理 TensorFlow 依赖，可以使用以下命令：

# 自动安装 CPU 版 TensorFlow
pip install luminoth[tf]

# 或自动安装 GPU 版 TensorFlow
pip install luminoth[tf-gpu]

若需使用 Google Cloud ML Engine 进行训练，请安装额外依赖：

pip install luminoth[gcloud]

方式二：从源码安装

适合需要修改代码或体验最新特性的开发者：

git clone https://github.com/tryolabs/luminoth.git
cd luminoth
pip install -e .

验证安装

安装完成后，运行以下命令检查是否成功：

lumi --help

如果输出了帮助信息列表，则说明安装成功。

基本使用

Luminoth 的核心功能通过 lumi 命令行工具调用。

1. 查看帮助

随时可以通过以下命令查看可用选项和子命令说明：

lumi --help
lumi <subcommand> --help

2. 数据集准备

在使用前，您需要将数据集转换为 Luminoth 支持的格式。具体适配方法请参考官方文档中的 Adapting a dataset 章节。

3. 训练模型

配置好数据集后，即可开始训练（支持本地训练或 Google Cloud 训练）：

# 示例：启动训练任务（具体参数需根据配置文件调整）
lumi train --config your_config.yml

详细训练指南请参阅：Training your own model。

4. 可视化结果

训练过程中的日志和计算图默认保存在当前目录下的 jobs/ 文件夹中。您可以使用 TensorBoard 进行可视化监控：

tensorboard --logdir path/to/jobs

在浏览器中打开 TensorBoard 提供的地址，即可观察损失曲线、检测效果预览及模型结构图。

---

注：目前支持的模型包括 Faster R-CNN 和 SSD，并提供在 COCO 和 Pascal VOC 数据集上的预训练权重。