API Reference#
Complete API documentation for all visualkeras modules.
Main Functions#
The main entry points for visualkeras:
visualkeras.show()- Unified interface for all renderers (recommended for most use cases)visualkeras.layered_view()- Visualize models in layered style (great for CNNs)visualkeras.graph_view()- Visualize models as graphs (works for all types)visualkeras.functional_view()- Visualize functional models with graph-aware layeringvisualkeras.lenet_view()- Classic feature map stack visualization (LeNet style)
Utility Classes#
visualkeras.SpacingDummyLayer- Add visual spacing between layer groups
Module Documentation#
- Layered
- Functional
- Graph
- LeNet Style
- Layer Utils
- Options
- Advanced Styling Reference
- Overview
- Grouped Highlights (layered_groups)
- Logos and Branding (logo_groups, logos_legend)
- Per-Layer Styling (styles Parameter)
- Image Embedding (face_image)
- Image-Fitting Options (image_axis, image_fit)
- Text Callables and Labels
- Dimension Display Options
- SizingMode Strategies
- Complete Advanced Example
- Tips and Best Practices
- See Also
- Utils
Quick Reference#
Unified Interface (Recommended)
import visualkeras
# Select renderer by mode
img = visualkeras.show(model, mode='layered')
Layered View
visualkeras.layered_view(model).show()
Graph View
visualkeras.graph_view(model).show()
Functional View
visualkeras.functional_view(model).show()
LeNet View
visualkeras.lenet_view(model).show()
With Options
from visualkeras.options import LayeredOptions
opts = LayeredOptions(spacing=15, legend=True)
visualkeras.layered_view(model, options=opts).show()
Getting Help#
Quickstart - Getting started quickly
Tutorials - Step-by-step guides
Examples - Example gallery
Advanced Features and Techniques - Advanced techniques