AWS neptune-analytics documentation change
Summary
Updated documentation for .degreeDistribution algorithm with corrected parameters, added output structure details, and revised examples
Security assessment
Changes involve parameter clarification (vertexLabels/edgeLabels swap), output format documentation, and example updates. No security advisories, vulnerability fixes, or access control changes are present. Modifications appear to be routine documentation improvements for accuracy and completeness.
Diff
diff --git a/neptune-analytics/latest/userguide/degreeDistribution.md b/neptune-analytics/latest/userguide/degreeDistribution.md index 6594c2935..02341e3fb 100644 --- a//neptune-analytics/latest/userguide/degreeDistribution.md +++ b//neptune-analytics/latest/userguide/degreeDistribution.md @@ -5 +5 @@ -SyntaxInputsSample outputQuery examples +SyntaxInputsOutputsQuery examplesSample output @@ -7 +7 @@ SyntaxInputsSample outputQuery examples -# .degreeDistribution centrality algorithm +# .degreeDistribution algorithm @@ -13 +13 @@ The `.degreeDistribution` algorithm is a tool for analyzing and visualizing the -The `%degreeDistribution` magic command in the notebook provides an interactive visualization of the output, please see the [notebook magics](https://docs.aws.amazon.com//neptune/latest/userguide/notebooks-magics.html#notebooks-line-magics-degree-distribution) documentation for details. +The `%degreeDistribution` magic command in the notebook provides an interactive visualization of the output, please see the [notebook magics](https://docs.aws.amazon.com//neptune/latest/userguide/notebooks-magics.html#notebooks-line-magics-degreeDistribution) documentation for details. @@ -19,0 +20 @@ The `%degreeDistribution` magic command in the notebook provides an interactive + vertexLabels: [a list of vertex labels for filtering (optional)], @@ -21 +21,0 @@ The `%degreeDistribution` magic command in the notebook provides an interactive - vertexLabels: "a list of vertex labels for filtering (optional)", @@ -23 +23 @@ The `%degreeDistribution` magic command in the notebook provides an interactive - traversalDirection: the direction of edge used for degree computation (optional, default: "both", + traversalDirection: the direction of edge used for degree computation (optional, default: "both"), @@ -30 +30 @@ The `%degreeDistribution` magic command in the notebook provides an interactive -## Inputs for the `.degreeDistribution` algorithm +## `.degreeDistribution` inputs @@ -34 +34 @@ The `%degreeDistribution` magic command in the notebook provides an interactive - * **edgeLabels** _(optional)_ – _type:_ a list of edge label strings; _example:_ `["route", `...`]`; _default:_ no edge filtering. + * **vertexLabels** _(optional)_ – _type:_ a list of vertex label strings; _example:_ `["airport", `...`]`; _default:_ no vertex filtering. @@ -36 +36 @@ The `%degreeDistribution` magic command in the notebook provides an interactive -To filter on one more edge labels, provide a list of the ones to filter on. If no `edgeLabels` field is provided then all edge labels are processed during traversal. +To filter on one more vertex labels, provide a list of the ones to filter on. If no `vertexLabels` field is provided then all vertex labels are processed during traversal. @@ -38 +38 @@ To filter on one more edge labels, provide a list of the ones to filter on. If n - * **vertexLabels** _(optional)_ – _type:_ `a list of vertex label strings`; _default: no vertex filtering_. + * **edgeLabels** _(optional)_ – _type:_ a list of edge label strings; _example:_ `["route", `...`]`; _default:_ no edge filtering. @@ -40 +40 @@ To filter on one more edge labels, provide a list of the ones to filter on. If n -To filter on one or more vertex labels, provide a list of the ones to filter on. If no vertexLabels field is provided then all vertex labels are considered for degree computation. +To filter on one more edge labels, provide a list of the ones to filter on. If no `edgeLabels` field is provided then all edge labels are processed during traversal. @@ -58,0 +59,46 @@ If set to `0`, uses all available threads to complete execution of the individua +## `.degreeDistribution` outputs + +There is a single column in the output containing a map with the following key components: + + * **distribution** – A list of lists where each list item is as follows: + + * [`degree`, `count`] – Degree and corresponding count. The list is sorted in the increasing order of `degree`. + + * **statistics** – A map with the following components: + + * `maxDeg` – the maximum degree in the graph. + + * `mean` – the average degree in the graph. + + * `minDeg` – the minimum degree in the graph. + + * `p50` – the 50th percentile degree in the graph, i.e., median. + + * `p75` – the 75th percentile degree in the graph. + + * `p90` – the 90th percentile degree in the graph. + + * `p95` – the 95th percentile degree in the graph. + + * `p99` – the 99th percentile degree in the graph. + + * `p999` – the 99.9th percentile degree in the graph. + + + + +## `.degreeDistribution` query examples + +This is a standalone example, where the in-degree distribution is computed for the graph with specified vertex labels and edge label, and the mean degree is returned. + + + CALL neptune.algo.degreeDistribution({ + vertexLabels: ['airport', 'country'], + edgeLabels: ['route'], + traversalDirection: 'inbound', + }) + YIELD output + WITH output.statistics.mean as meanDegree + RETURN meanDegree + + @@ -93,15 +138,0 @@ Here is an example of the output returned by .degreeDistribution when run agains -## Query examples for `.degreeDistribution` - -This is a standalone example, where the in-degree distribution is computed for the graph with specified vertex labels and edge label, and the mean degree is returned. - - - CALL neptune.algo.degreeDistribution({ - vertexLabels: ['airport', 'country'], - edgeLabels: ['route'], - traversalDirection: 'inbound', - }) - YIELD output - WITH output.statistics.mean as meanDegree - RETURN meanDegree - - @@ -114 +145 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -.degree.mutate +Property graph schema @@ -116 +147 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -.pageRank +Vector similarity