3D knowledge graph visualization for Python — Jupyter, Streamlit, Gradio, Dash, and more
Project description
kgviz
3D knowledge graph visualization for Python — works like Plotly/Altair across Jupyter notebooks, Streamlit, Gradio, Dash, marimo, and plain HTML export.
Repository: github.com/dataprofessor/kgviz
Project layout
kgviz/ Python wrapper — data prep, HTML export, framework adapters
viewer/ Browser component — React/Three.js 3D renderer (see viewer/README.md)
example/ Streamlit demo
AGENTS.md Architecture guide for contributors and coding agents
Install
Python (pip):
pip install kgviz
pip install "kgviz[all]" # Streamlit, Jupyter, maps, etc.
Node CLI (npm) — no Python required for HTML export and session maps:
# One-off (no install) — good for trying it
npx kgviz help
# Or install globally and run `kgviz` directly
npm install -g kgviz
kgviz help
Quick start
from kgviz import Graph3D, kgviz
nodes = [
{"id": "A", "label": "Alpha", "color": "#ff0000", "size": 5},
{"id": "B", "label": "Beta", "color": "#00ff00", "size": 4},
{"id": "C", "label": "Gamma", "color": "#0000ff", "size": 3},
]
edges = [
{"source": "A", "target": "B"},
{"source": "B", "target": "C"},
]
fig = Graph3D(nodes=nodes, edges=edges, show_labels=True)
fig.show() # Jupyter cell or browser
fig.to_html() # embed anywhere
Knowledge-graph preset
from kgviz import Graph3D
fig = Graph3D.kg_preset(
nodes=nodes,
edges=edges,
node_color_by="type",
node_size_by="degree",
edge_color_by="relation",
edge_width_by="weight",
edge_label="label",
show_edge_labels=True,
show_legend=True,
)
Explorer features: schema legend (click to filter), multi-property search, multi-select, double-click neighborhood focus, typed edge labels/colors/widths, selection events for Streamlit sidebars.
Embedding maps (PCA, t-SNE, UMAP, SOM)
Cosmograph-style 2D scatter maps from feature vectors (paper embeddings, node attributes, etc.):
pip install "kgviz[maps]" # numpy, scikit-learn, umap-learn, minisom
from kgviz import Graph3D
import numpy as np
nodes = [{"id": i, "label": f"Doc {i}", "topic": i % 5} for i in range(200)]
features = np.random.randn(200, 32) # or sentence-transformer embeddings
fig = Graph3D.from_map(
nodes,
features,
method="tsne", # pca | tsne | umap | som
node_color_by="topic", # or cluster from auto k-means
knn_k=0, # 3 for light KNN overlay like Topic Explorer
)
fig.show()
Lower-level API: from kgviz.layouts import compute_layout, build_map_graph, apply_layout_to_nodes.
Large maps (10k–100k+ points): map_mode draws points on a canvas overlay (2D scatter or 3D orbit). Performance tiers automatically reduce labels and effects on big datasets. Regular knowledge graphs still use the Three.js 3D renderer for force-directed layouts.
python3 example/generate_map_demo_large.py # demo_map_10k.html, demo_map_50k.html
AI coding session maps (example use case)
Explore where your agent conversations cluster — by topic, project, or tool — as an interactive 2D/3D embedding map. Each point is a message turn or whole session (with --per-session).
| Tool | Default data path | What gets read |
|---|---|---|
| Snowflake Cortex Code | ~/.snowflake/cortex/conversations/**/*.history.jsonl |
Cortex agent chats |
| Cursor IDE | ~/.cursor/projects/*/agent-transcripts/**/*.jsonl |
Cursor agent transcripts |
| Claude Code (CLI) | ~/.claude/projects/<project>/*.jsonl |
Claude Code session logs (local storage) |
Python (full t-SNE / UMAP on large histories):
pip install "kgviz[maps]"
# Cortex Code (default)
python3 example/generate_map_demo_sessions.py --per-session
# Cursor IDE transcripts
python3 example/generate_map_demo_sessions.py --source cursor --per-session --color-by project
# Claude Code CLI
python3 example/generate_map_demo_sessions.py --source claude --per-session
# All sources on one map
python3 example/generate_map_demo_sessions.py --source all --color-by source
python3 serve_demo.py # → http://127.0.0.1:8765/demo_map_sessions_tsne.html
Options: --per-session, --color-by topic|source|workspace|project, --method pca for faster layout. Session HTML files are gitignored (private chat text) — generate locally only.
Node CLI (npm / npx)
Package: kgviz on npm (npx = run without installing; npm install -g = install the kgviz command).
# Either form works:
npx kgviz build graph.json -o graph.html
kgviz build graph.json -o graph.html # after: npm install -g kgviz
npx kgviz sessions --per-session -o sessions.html
npx kgviz sessions --source claude --color-by project
npx kgviz sessions --source all --color-by source
npx kgviz serve sessions.html
See packages/kgviz/README.md for all flags.
Framework usage
Jupyter / IPython
fig # auto-displays via _repr_html_
Streamlit
import streamlit as st
from kgviz import kgviz
click = kgviz(nodes=nodes, edges=edges, key="graph")
Gradio
import gradio as gr
from kgviz import Graph3D
from kgviz.integrations import gradio_html
fig = Graph3D(nodes=nodes, edges=edges)
gr.HTML(gradio_html(fig))
Dash
from kgviz import Graph3D
from kgviz.integrations import dash_iframe
fig = Graph3D(nodes=nodes, edges=edges)
layout = dash_iframe(fig, height=600)
Standalone HTML demo
cd /path/to/kgviz
python3 serve_demo.py
Open http://127.0.0.1:8765/demo.html (must use serve_demo.py or cd example before python3 -m http.server).
Development
cd viewer && npm install && npm run build
pip install -e ".[dev,all]"
python3 -m pytest tests/ -q
python3 -m playwright install chromium # once, for browser tests
python3 -m pytest tests/test_browser_playwright.py -q
streamlit run example/app.py
Notebook demo: example/notebook_demo.ipynb
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kgviz-0.2.0.tar.gz.
File metadata
- Download URL: kgviz-0.2.0.tar.gz
- Upload date:
- Size: 529.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bd7b13c0ccb9f78e3b5804797dc65faad774cc0710e589cfbfd10517a54be706
|
|
| MD5 |
855e4bce1a598383f634fd3cf12b0e84
|
|
| BLAKE2b-256 |
e37f1a5aba6d5a78efcfa760b6db45aa24bb92f8ea22463fdef4a84ba6138288
|
File details
Details for the file kgviz-0.2.0-py3-none-any.whl.
File metadata
- Download URL: kgviz-0.2.0-py3-none-any.whl
- Upload date:
- Size: 527.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
89809294bf55282b173a5ae1b8911cfcbea5e8e569ae481f44395685b372f162
|
|
| MD5 |
539f5f021be5d4641f28837473b20190
|
|
| BLAKE2b-256 |
a6c83d18350c8794dbcb2c46fa231ba97c7febde859f0e55fcb5e10bb845fcb0
|