Skip to content

Commit

Permalink
nit: add link to code hierarchy notebook (#11769)
Browse files Browse the repository at this point in the history
cr
  • Loading branch information
jerryjliu authored Mar 9, 2024
1 parent 81cdc98 commit 890377e
Showing 1 changed file with 3 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
"source": [
"# Code Hierarchy Node Parser\n",
"\n",
"<a href=\"https://colab.research.google.com/github/run-llama/llama_index/blob/main/llama-index-packs/llama-index-packs-code-hierarchy/examples/CodeHierarchyNodeParserUsage.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
"\n",
"The `CodeHierarchyNodeParser` is useful to split long code files into more reasonable chunks. What this will do is create a \"Hierarchy\" of sorts, where sections of the code are made more reasonable by replacing the scope body with short comments telling the LLM to search for a referenced node if it wants to read that context body. This is called skeletonization, and is toggled by setting `skeleton` to `True` which it is by default. Nodes in this hierarchy will be split based on scope, like function, class, or method scope, and will have links to their children and parents so the LLM can traverse the tree.\n",
"\n",
"This notebook gives an initial demo of the pack, and then dives into a deeper technical exploration of how it works.\n",
Expand Down Expand Up @@ -51,7 +53,7 @@
}
],
"source": [
"!pip install llama-index-packs-code-hierarchy"
"!pip install llama-index-packs-code-hierarchy llama-index"
]
},
{
Expand Down

0 comments on commit 890377e

Please sign in to comment.