visualkeras 用于 Keras / TensorFlow

Visualkeras 是一个用于可视化 Keras 和 TensorFlow 模型架构的 Python 包。它支持多种渲染样式，例如经典的分层 CNN 图、基于节点的可视化以及 LeNet 风格的可视化。使用 Visualkeras 非常简单（参见快速入门），同时也为高级用户提供了高度可定制性。如需引用本项目，请参阅 此处。

安装

安装最新发布的版本：

pip install visualkeras

安装最新的 master 分支（可能不稳定）：

pip install git+https://github.com/paulgavrikov/visualkeras

快速入门

import visualkeras

model = ...

visualkeras.layered_view(model).show()
visualkeras.layered_view(model, to_file="model.png")

推荐的高级 API 是 show(...)，它会根据模式选择渲染器：

import visualkeras
from tensorflow.keras import layers
from visualkeras.options import FunctionalOptions

img = visualkeras.show(
    model,
    mode="functional",
    options=FunctionalOptions(
        collapse_enabled=True,
        collapse_rules=[
            {"kind": "layer", "selector": layers.Dense, "repeat_count": 4},
            {
                "kind": "block",
                "selector": [layers.Dense, layers.Dropout],
                "repeat_count": 2,
                "annotation_position": "below",
            },
        ],
    ),
)

show(...) 支持以下模式：

• layered
• graph
• functional
• lenet

渲染器

渲染器	最适合	入口点
分层视图	顺序 CNN 风格的图表	visualkeras.layered_view(model)
图形视图	通用的基于节点的可视化	visualkeras.graph_view(model)
函数式视图	具有多模态、多输入、多输出、多流等功能的 Keras 模型；这是最灵活的选项	visualkeras.functional_view(model)
LeNet 视图	经典的特征图堆栈图；灵感来自 LeNet	visualkeras.lenet_view(model)

示例

我们在此提供一些基本示例。包含各种选项和自定义设置的示例则在文档中有所介绍：https://visualkeras.readthedocs.io/。

分层视图

import tensorflow as tf
from tensorflow import keras
import visualkeras

model = keras.Sequential([
    keras.layers.Input(shape=(28, 28, 1)),
    keras.layers.Conv2D(32, (3, 3), activation="relu"),
    keras.layers.MaxPooling2D((2, 2)),
    keras.layers.Conv2D(64, (3, 3), activation="relu"),
    keras.layers.Flatten(),
    keras.layers.Dense(10, activation="softmax"),
])

visualkeras.layered_view(model).show()

图形视图

import tensorflow as tf
from tensorflow import keras
import visualkeras

model = Sequential([
    Conv2D(32, (3, 3), activation='relu', input_shape=(28, 28, 1)),
    MaxPooling2D((2, 2)),
    Dense(10, activation='softmax')
])

visualkeras.graph_view(model)

函数式视图

import tensorflow as tf
from tensorflow import keras
import visualkeras

inputs = keras.Input(shape=(16,))
x = keras.layers.Dense(32, activation='relu')(inputs)
x = keras.layers.Dense(32, activation='relu')(x)
outputs = keras.layers.Dense(10, activation='softmax')(x)

model = keras.Model(inputs=inputs, outputs=outputs)

visualkeras.functional_view(model)

LeNet 视图

import tensorflow as tf
from tensorflow import keras
import visualkeras

model = keras.Sequential([
    keras.layers.Input(shape=(28, 28, 1)),
    keras.layers.Conv2D(6, (5, 5), activation='tanh'),
    keras.layers.MaxPooling2D((2, 2)),
    keras.layers.Conv2D(16, (5, 5), activation='tanh'),
    keras.layers.MaxPooling2D((2, 2)),
    keras.layers.Flatten(),
    keras.layers.Dense(120, activation='tanh'),
    keras.layers.Dense(84, activation='tanh'),
    keras.layers.Dense(10, activation='softmax')
])

visualkeras.lenet_view(model)

文档

详细的文档可以在文档网站上找到：https://visualkeras.readthedocs.io/。

特别有用的章节包括：

• 快速入门： https://visualkeras.readthedocs.io/en/latest/quickstart.html
• 教程： https://visualkeras.readthedocs.io/en/latest/tutorials/index.html
• 示例： https://visualkeras.readthedocs.io/en/latest/examples/index.html
• API 参考： https://visualkeras.readthedocs.io/en/latest/api/index.html
• 架构指南： ARCHITECTURE.md

兼容性

范围	状态	备注
核心包	支持	Python 3.9+
tf.keras 工作流	支持	建议使用
独立的 keras	大部分支持	可能因后端配置而异；使用 TensorFlow 后端时完全支持

引用

如果您觉得本项目对您的研究有所帮助，请引用如下：

@misc{Gavrikov2020VisualKeras,
  author = {Gavrikov, Paul and Patapati, Santosh},
  title = {visualkeras},
  year = {2020},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/paulgavrikov/visualkeras}},
}

贡献

• 问题： https://github.com/paulgavrikov/visualkeras/issues
• 贡献指南： CONTRIBUTING.MD
• 架构指南： ARCHITECTURE.md

保持更新

请在此处订阅 Visualkeras 邮件列表： https://forms.gle/7eBZ1jCJ7Xsm6RvA7

许可证

Visualkeras 采用 MIT 许可证授权。详情请参阅 LICENSE。

visualkeras 快速上手指南

visualkeras 是一个用于可视化 Keras 和 TensorFlow 模型架构的 Python 库。它支持多种渲染风格，包括经典的层叠式 CNN 图、基于节点的拓扑图以及 LeNet 风格的特征图堆叠图，能够帮助开发者直观地理解模型结构。

环境准备

在开始使用前，请确保满足以下系统要求：

• 操作系统：Windows, macOS, 或 Linux
• Python 版本：3.9 及以上
• 核心依赖：
  • tensorflow (推荐) 或 keras
  • Pillow (用于图像生成，通常会自动安装)
• 后端说明：虽然支持 standalone keras，但强烈建议使用 tf.keras 以获得最佳兼容性。

安装步骤

1. 使用国内镜像源加速安装（推荐）

在中国大陆地区，建议使用清华或阿里镜像源以加快下载速度：

pip install visualkeras -i https://pypi.tuna.tsinghua.edu.cn/simple

2. 标准安装

若无需加速，可直接安装最新稳定版：

pip install visualkeras

3. 安装开发版（可选）

如需体验最新功能（可能不稳定），可安装 master 分支：

pip install git+https://github.com/paulgavrikov/visualkeras

基本使用

visualkeras 提供了多种视图模式，最常用的是层叠视图 (Layered View)，适合展示顺序连接的 CNN 模型。

最简单的使用示例

以下代码演示如何构建一个简单的 Sequential 模型并生成可视化图片：

import tensorflow as tf
from tensorflow import keras
import visualkeras

# 1. 定义一个简单的 Keras 模型
model = keras.Sequential([
    keras.layers.Input(shape=(28, 28, 1)),
    keras.layers.Conv2D(32, (3, 3), activation="relu"),
    keras.layers.MaxPooling2D((2, 2)),
    keras.layers.Conv2D(64, (3, 3), activation="relu"),
    keras.layers.Flatten(),
    keras.layers.Dense(10, activation="softmax"),
])

# 2. 生成层叠视图并直接显示
visualkeras.layered_view(model).show()

# 3. 或者将结果保存为文件
visualkeras.layered_view(model, to_file="model_structure.png")

其他视图模式简介

除了默认的层叠视图，库还支持以下模式，可通过 visualkeras.show() 统一调用：

• Graph View (graph): 适用于通用的节点连接图。
• Functional View (functional): 最灵活的模式，适用于具有多输入、多输出或复杂分支的函数式模型。
• LeNet View (lenet): 经典的特征图堆叠风格，灵感源自 LeNet 论文。

高级用法示例（使用 Functional 模式）：

import visualkeras
from visualkeras.options import FunctionalOptions

# 使用 show 方法指定模式
img = visualkeras.show(
    model,
    mode="functional",
    options=FunctionalOptions(
        collapse_enabled=True, # 启用折叠
        collapse_rules=[
            {"kind": "layer", "selector": keras.layers.Dense, "repeat_count": 4},
        ],
    ),
)

更多自定义选项和详细教程请参考官方文档：https://visualkeras.readthedocs.io/