diff --git a/.semversioner/next-release/patch-20241106193551070554.json b/.semversioner/next-release/patch-20241106193551070554.json new file mode 100644 index 00000000..48e7ce9a --- /dev/null +++ b/.semversioner/next-release/patch-20241106193551070554.json @@ -0,0 +1,4 @@ +{ + "type": "patch", + "description": "Fix a file paths issue in the viz guide." +} diff --git a/docs/visualization_guide.md b/docs/visualization_guide.md index 3a249929..539dd509 100644 --- a/docs/visualization_guide.md +++ b/docs/visualization_guide.md @@ -16,6 +16,7 @@ umap: enabled: true # will generate UMAP embeddings for nodes ``` After running the indexing pipeline over your data, there will be an output folder (defined by the `storage.base_dir` setting). + - **Output Folder**: Contains artifacts from the LLM’s indexing pass. ## 2. Locate the Knowledge Graph @@ -27,7 +28,7 @@ In the output folder, look for a file named `merged_graph.graphml`. graphml is a 3. Import the `merged_graph.graphml` file into Gephi. This will result in a fairly plain view of the undirected graph nodes and edges.

- A basic graph visualization by Gephi + A basic graph visualization by Gephi

## 4. Install the Leiden Algorithm Plugin @@ -39,7 +40,7 @@ In the output folder, look for a file named `merged_graph.graphml`. graphml is a 1. In the `Statistics` tab on the right, click `Run` for `Average Degree` and `Leiden Algorithm`.

- A view of Gephi's network overview settings + A view of Gephi's network overview settings

2. For the Leiden Algorithm, adjust the settings: @@ -50,7 +51,7 @@ In the output folder, look for a file named `merged_graph.graphml`. graphml is a 1. Go to the `Appearance` pane in the upper left side of Gephi.

- A view of Gephi's appearance pane + A view of Gephi's appearance pane

2. Select `Nodes`, then `Partition`, and click the color palette icon in the upper right. @@ -71,7 +72,7 @@ In the output folder, look for a file named `merged_graph.graphml`. graphml is a 1. In the `Layout` tab in the lower left, select `OpenORD`.

- A view of Gephi's layout pane + A view of Gephi's layout pane

2. Set `Liquid` and `Expansion` stages to 50, and everything else to 0. @@ -81,7 +82,7 @@ In the output folder, look for a file named `merged_graph.graphml`. graphml is a 1. Select `Force Atlas 2` in the layout options.

- A view of Gephi's ForceAtlas2 layout pane + A view of Gephi's ForceAtlas2 layout pane

2. Adjust the settings: