Skip to content

Commit

Permalink
adde dnew docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Niklas Abraham - INFlux committed Aug 14, 2024
1 parent 8edc80a commit 794030c
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion docs/examples/network.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,27 @@
"graph.visualize(color=\"domain\")"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Graph connectivity"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"The threshold in the network has a big impact on potenital visualiztions, and has therfore to be tuned right. This is a task that looks different for each individual graph. In the command `update_threshold` multiple options can be choosen. In the function `update_threshhold(threshold: float, threshold_mode: str = \"UNDER_THRESHOLD\")`, there are two parameters, which can be adjusted, the threshold is the float and the threshold_mode allows two possible setting. The first default setting says that all the edges under the given threshold are hidden. The other option is `\"ABOVE_THRESHOLD\"` and it allows the edges above the threshold to be hidden."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"In the most used case, where the identiy is used as the weight, a threshold (with mode UNDER_THRESHOLD) which is too small will result in a network that has too many edges and a too big theshold will result in to little edges. "
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down Expand Up @@ -332,7 +353,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.5"
"version": "3.12.4"
}
},
"nbformat": 4,
Expand Down

0 comments on commit 794030c

Please sign in to comment.