Fabrik 是一个在线协作平台，通过简单的拖放界面即可构建、可视化并训练深度学习模型。它使研究人员能够使用支持导入、编辑和导出网络到 Caffe、Keras 和 TensorFlow 等流行框架的 Web GUI，共同开发和调试模型。

目前，该应用正处于积极开发中，我们欢迎各方贡献。请查看我们的 问题讨论区，寻找可参与的工作内容，或在 Gitter 上与我们交流。

安装说明

在本地机器上搭建 Fabrik 非常简单。您可以通过两种方法进行设置：

使用 Docker

Docker 安装

如果您尚未安装 Docker：

Windows 用户请 点击此处 安装。

Mac 用户请 点击此处 安装。

Fabrik 安装

1. 通过 git 将源代码获取到您的机器上。

   git clone https://github.com/Cloud-CV/Fabrik.git && cd Fabrik
   

2. 将 settings/dev.sample.py 重命名为 dev.py。

   cp settings/dev.sample.py settings/dev.py
   

3. 构建并运行 Docker 容器。这可能需要一些时间。现在您应该能够访问 Fabrik，地址为 http://0.0.0.0:8000。

   docker-compose up --build
   

为 Docker 环境设置认证

1. 前往 GitHub 开发者应用并创建一个新的应用。这里

2. 对于本地部署，应在选项中使用以下设置：

   • 应用名称：Fabrik
   • 主页 URL：http://0.0.0.0:8000
   • 应用描述：Fabrik
   • 授权回调 URL：http://0.0.0.0:8000/accounts/github/login/callback/

3. GitHub 将为您提供 Client ID 和 Secret Key，请妥善保存。

4. 在 Docker 容器的 Django 服务中创建超级用户。

   docker-compose run django python manage.py createsuperuser
   

   注意：在创建超级用户之前，请确保 Docker 镜像中的 Django 服务正在运行。可通过执行 docker-compose up 后按 Ctrl + C 来保存 Docker 配置。

5. 打开 http://0.0.0.0:8000/admin，并使用第 4 步中的凭据登录。

6. 在 Django 管理后台设置社交账号

   • 在 社交账号 下，打开 社交应用 并点击 添加社交应用。

   • 选择社交应用的 提供商 为 Github，并将其命名为 Github。

   • 将可用站点添加到右侧，以便允许 GitHub 访问当前站点。

   • 将您的 Client ID 和 Secret Key 复制并粘贴到相应字段中，然后保存。

7. 转到 站点 选项卡，将 域名 更新为 0.0.0.0:8000。

使用虚拟环境

1. 首先设置一个 virtualenv。Fabrik 运行在 Python 2.7 上。

   sudo apt-get install python-pip python-dev python-virtualenv
   virtualenv --system-site-packages ~/Fabrik --python=python2.7
   source ~/Fabrik/bin/activate
   

2. 通过 git 克隆仓库

   git clone --recursive https://github.com/Cloud-CV/Fabrik.git && cd Fabrik
   

3. 将 settings/dev.sample.py 重命名为 settings/dev.py，并修改 settings/dev.py 中的凭据

   cp settings/dev.sample.py settings/dev.py
   

   • 将 settings/dev.py 第 15 行中的主机名改为 localhost。现在应如下所示：

   'HOST': os.environ.get("POSTGRES_HOST", 'localhost'), 
   

4. 安装 Redis 服务器

   sudo apt-get install redis-server
   

   • 将 settings/common.py 第 115 行中的主机名改为 localhost。

     "CONFIG": {
         # 如果在本地系统上运行，请将 Redis 主机名替换为 localhost
         "hosts": [("localhost", 6379)],
         "prefix": u'fabrik:',
         },
     

   • 将 settings/common.py 第 122 行中的 Celery 结果后端替换为 localhost。

     CELERY_RESULT_BACKEND = 'redis://localhost:6379/0'
     

   • 将 ide/celery_app.py 第 8 行中的 Celery 代理 URL 和结果后端主机名改为 localhost。

     app = Celery('app', broker='redis://localhost:6379/0', backend='redis://localhost:6379/0', include=['ide.tasks'])
     

5. 如果您的计算机上已经安装了 Caffe、Keras 和 TensorFlow，请跳过此步骤。

• 对于 Linux 用户：

  • 安装 Caffe、Keras 和 TensorFlow

    cd Fabrik/requirements
    yes Y | sh caffe_tensorflow_keras_install.sh
    

  • 打开您的 ~/.bashrc 文件，并在末尾添加以下行

    export PYTHONPATH=~/caffe/caffe/python:$PYTHONPATH
    

  • 保存并退出，然后运行

    source ~/.bash_profile
    cd ..
    

• 对于 Mac 用户：

  • 安装 Caffe
  • 安装 TensorFlow
  • 安装 Keras

6. 安装依赖项

• 对于开发者：

  pip install -r requirements/dev.txt
  

• 对于其他用户：

  pip install -r requirements/common.txt
  

7. 安装 PostgreSQL >= 9.5

• 设置 PostgreSQL 数据库

  • 输入 sudo service postgresql start 启动 PostgreSQL

  • 然后以用户 postgres 身份登录，运行 sudo -u postgres psql 并输入以下命令：

    CREATE DATABASE fabrik;
    CREATE USER admin WITH PASSWORD 'fabrik';
    ALTER ROLE admin SET client_encoding TO 'utf8';
    ALTER ROLE admin SET default_transaction_isolation TO 'read committed';
    ALTER ROLE admin SET timezone TO 'UTC';
    ALTER USER admin CREATEDB;
    

  • 输入 \q 并按回车键退出 psql。

• 迁移

  python manage.py makemigrations caffe_app
  python manage.py migrate
  

8. 安装 Node 模块

   npm install
   npm install --save-dev json-loader
   sudo npm install -g webpack@1.15.0
   

   • 在另一个终端中运行以下命令以实现热重载，即实时查看 UI 的更改。

   webpack --progress --watch --colors
   

9. 启动 Celery 工作进程

   celery -A ide worker --app=ide.celery_app  --loglevel=info
   

   Celery 工作进程需要与 Django 服务器在不同的终端中并行运行。

10. 启动 Django 应用程序

    python manage.py runserver
    

    现在您应该能够访问 Fabrik，网址为 http://localhost:8000。

为虚拟环境设置身份验证

1. 前往 GitHub 开发者应用并创建一个新的应用。这里

2. 对于本地部署，应在选项中使用以下内容：

   • 应用名称：Fabrik
   • 主页 URL：http://localhost:8000
   • 应用描述：Fabrik
   • 授权回调 URL：http://localhost:8000/accounts/github/login/callback/

3. GitHub 将为您提供客户端 ID 和密钥，请保存这些信息。

4. 在 Django 中创建超级用户

   python manage.py createsuperuser
   

5. 启动应用程序

   python manage.py runserver
   

6. 打开 http://localhost:8000/admin

7. 使用第 4 步中的凭据登录。

8. 在 Django 管理后台设置社交账户：

   • 在 社交账户 下，打开 社交应用，点击 添加社交应用。

   • 选择社交应用的 提供商 为 Github，并将其命名为 Github。

   • 将可用站点添加到右侧，以便允许 GitHub 访问当前站点。对于本地部署，这应该是 localhost:8000。

   • 将您的 客户端 ID 和 密钥 复制并粘贴到相应字段中，然后保存。

9. 从 Django 管理主页的 站点 类别中，进入 站点，并将 域名 更新为 localhost:8000。

注意：在测试时，您只需要一个身份验证后端。但是，如果您想尝试 Google 的身份验证，则需要按照上述步骤操作，只是将 Github 替换为 Google。

使用方法

python manage.py runserver

示例

• 使用 example/tensorflow/GoogleNet.pbtxt 导入 TensorFlow
• 使用 example/caffe/GoogleNet.prototxt 导入 Caffe
• 使用 example/keras/vgg16.json 导入 Keras

已测试模型

目前支持的框架之间的模型转换已在部分模型上进行了测试。

模型	Caffe	Keras	Tensorflow
Inception V3	√	√	√
Inception V4	√	√	√
ResNet 101	√	√	√
VGG 16	√	√	√
GoogLeNet	√	×	×
SqueezeNet	√	×	×
DenseNet	√	×	×
AllCNN	√	×	×
AlexNet	√	√	√
FCN32 Pascal	√	×	×
YoloNet	√	√	√
Pix2Pix	√	×	×
VQA	√	√	√
Denoising Auto-Encoder	×	√	√

注意：对于使用自定义 LRN 层的模型（如 AlexNet），Keras 在从 JSON 加载时要求传入该自定义层。LRN.py 位于 keras_app/custom_layers 目录下。AlexNet 在 Keras 中的导入方法

文档

• 使用从 Fabrik 导出的 Keras 模型
• 加载并打印从 Fabrik 导出的 Keras 模型摘要
• 使用导出的 Caffe 模型
• 在 Python 中加载 Caffe 模型并打印其参数和输出尺寸
• Fabrik 已测试模型列表
• 将模型添加到 Fabrik 模型库
• 添加新层
• 在 Keras 中使用自定义层
• Linux 安装教程

许可证

本软件采用 GNU GPLv3 许可证。请参阅随附的许可证文件。所有外部库若经修改，将在下方明确说明。

Fabrik 快速上手指南

Fabrik 是一个基于 Web 的协作平台，支持通过拖拽界面构建、可视化和训练深度学习模型。它允许研究人员导入、编辑和导出 Caffe、Keras 和 TensorFlow 等主流框架的网络模型。

环境准备

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

• 操作系统: Linux (推荐 Ubuntu) 或 macOS。Windows 用户建议使用 Docker 方式部署。
• Python 版本: Python 2.7 (虚拟环境部署必需)。
• 核心依赖:
  • Git
  • PostgreSQL (版本 >= 9.5)
  • Redis Server
  • Node.js & npm
  • 深度学习框架 (可选，若需本地推理): Caffe, Keras, TensorFlow
• 部署方式选择:
  • Docker (推荐): 适合快速体验，环境隔离好，配置简单。
  • 虚拟环境: 适合开发者进行源码级修改和调试。

---

安装步骤

方法一：使用 Docker (推荐)

此方法最简便，自动处理所有依赖关系。

1. 获取源码

   git clone https://github.com/Cloud-CV/Fabrik.git && cd Fabrik
   

2. 配置文件初始化

   cp settings/dev.sample.py settings/dev.py
   

3. 构建并启动容器

   docker-compose up --build
   

   启动完成后，访问 http://0.0.0.0:8000 即可看到界面。

4. 配置管理员与认证 (首次运行必需)

   • 创建超级用户:

     docker-compose run django python manage.py createsuperuser
     

     (注意：执行前需确保 django 服务已运行，可先执行 docker-compose up 后按 Ctrl+C 暂停)

   • 配置 GitHub 登录:

     1. 访问 GitHub Developer Applications 创建新应用。
     2. 设置 Homepage URL 为 http://0.0.0.0:8000，Authorization callback URL 为 http://0.0.0.0:8000/accounts/github/login/callback/。
     3. 获取 Client ID 和 Secret Key。
     4. 登录 http://0.0.0.0:8000/admin，进入 Social Accounts -> Social applications，添加 Github 应用并填入上述 ID 和 Key。
     5. 进入 Sites，将 Domain name 更新为 0.0.0.0:8000。

---

方法二：使用虚拟环境 (开发者模式)

适合需要修改源码或集成本地深度学习环境的用户。

1. 设置 Python 2.7 虚拟环境

   sudo apt-get install python-pip python-dev python-virtualenv
   virtualenv --system-site-packages ~/Fabrik --python=python2.7
   source ~/Fabrik/bin/activate
   

2. 获取源码

   git clone --recursive https://github.com/Cloud-CV/Fabrik.git && cd Fabrik
   

3. 配置数据库与缓存连接

   cp settings/dev.sample.py settings/dev.py
   

   • 修改 settings/dev.py 第 15 行，将 HOST 设为 'localhost'。
   • 安装 Redis: sudo apt-get install redis-server
   • 修改 settings/common.py:
     • 第 115 行 hosts 改为 [("localhost", 6379)]
     • 第 122 行 CELERY_RESULT_BACKEND 改为 'redis://localhost:6379/0'
   • 修改 ide/celery_app.py 第 8 行，broker 和 backend 均指向 localhost。

4. 安装深度学习框架 (可选) 若本地已安装 Caffe/Keras/TensorFlow 可跳过。Linux 用户可运行：

   cd Fabrik/requirements
   yes Y | sh caffe_tensorflow_keras_install.sh
   echo "export PYTHONPATH=~/caffe/caffe/python:$PYTHONPATH" >> ~/.bashrc
   source ~/.bash_profile
   cd ..
   

5. 安装 Python 依赖

   # 开发者使用
   pip install -r requirements/dev.txt
   # 普通用户使用
   pip install -r requirements/common.txt
   

6. 配置 PostgreSQL 数据库 启动服务并创建数据库：

   sudo service postgresql start
   sudo -u postgres psql
   

   在 psql 中执行：

   CREATE DATABASE fabrik;
   CREATE USER admin WITH PASSWORD 'fabrik';
   ALTER ROLE admin SET client_encoding TO 'utf8';
   ALTER ROLE admin SET default_transaction_isolation TO 'read committed';
   ALTER ROLE admin SET timezone TO 'UTC';
   ALTER USER admin CREATEDB;
   \q
   

   执行迁移：

   python manage.py makemigrations caffe_app
   python manage.py migrate
   

7. 安装前端依赖

   npm install
   npm install --save-dev json-loader
   sudo npm install -g webpack@1.15.0
   

   (可选) 开启前端热重载: 新开终端运行 webpack --progress --watch --colors

8. 启动服务 需要两个终端分别运行：

   • 终端 1 (Celery Worker):

     celery -A ide worker --app=ide.celery_app  --loglevel=info
     

   • 终端 2 (Django Server):

     python manage.py runserver
     

   访问 http://localhost:8000。

9. 配置认证 参考 Docker 部分的“配置管理员与认证”步骤，但将域名替换为 localhost:8000。

---

基本使用

启动服务并登录后，您可以通过以下方式快速开始：

1. 导入现有模型: 点击界面上的导入按钮，选择对应的框架文件进行加载测试：

   • TensorFlow: 使用 example/tensorflow/GoogleNet.pbtxt
   • Caffe: 使用 example/caffe/GoogleNet.prototxt
   • Keras: 使用 example/keras/vgg16.json

2. 可视化与编辑: 模型加载后，将以节点图形式展示。您可以直接拖拽修改网络结构，查看各层参数。

3. 导出模型: 编辑完成后，可将模型导出为 Caffe、Keras 或 TensorFlow 格式，用于后续训练或部署。

提示: 目前工具对 Inception V3/V4, ResNet 101, VGG 16, AlexNet, YoloNet 等经典模型的跨框架转换支持较好。若使用包含自定义层（如 AlexNet 的 LRN 层）的 Keras 模型，加载时需注意传递自定义层定义。