From 6ef6bc2a561122f44c5fa8c1d0641abc896c84e7 Mon Sep 17 00:00:00 2001 From: Zeeshan Lakhani Date: Fri, 21 Jun 2024 15:13:19 +0000 Subject: [PATCH] chore: inline paper links --- openapi/nexus.json | 20 ++++++++++---------- oximeter/oximeter/src/histogram.rs | 4 ++-- oximeter/oximeter/src/quantile.rs | 3 ++- 3 files changed, 14 insertions(+), 13 deletions(-) diff --git a/openapi/nexus.json b/openapi/nexus.json index a3929963b1e..ab7192d1e0c 100644 --- a/openapi/nexus.json +++ b/openapi/nexus.json @@ -13247,7 +13247,7 @@ ] }, "squared_mean": { - "description": "M2 for Welford's algorithm for variance calculation.\n\nRead more on Welford's algorithm at ", + "description": "M2 for Welford's algorithm for variance calculation.\n\nRead about [Welford's algorithm](https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Welford's_online_algorithm) for more information on the algorithm.", "type": "number", "format": "double" }, @@ -13327,7 +13327,7 @@ ] }, "squared_mean": { - "description": "M2 for Welford's algorithm for variance calculation.\n\nRead more on Welford's algorithm at ", + "description": "M2 for Welford's algorithm for variance calculation.\n\nRead about [Welford's algorithm](https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Welford's_online_algorithm) for more information on the algorithm.", "type": "number", "format": "double" }, @@ -13407,7 +13407,7 @@ ] }, "squared_mean": { - "description": "M2 for Welford's algorithm for variance calculation.\n\nRead more on Welford's algorithm at ", + "description": "M2 for Welford's algorithm for variance calculation.\n\nRead about [Welford's algorithm](https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Welford's_online_algorithm) for more information on the algorithm.", "type": "number", "format": "double" }, @@ -13487,7 +13487,7 @@ ] }, "squared_mean": { - "description": "M2 for Welford's algorithm for variance calculation.\n\nRead more on Welford's algorithm at ", + "description": "M2 for Welford's algorithm for variance calculation.\n\nRead about [Welford's algorithm](https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Welford's_online_algorithm) for more information on the algorithm.", "type": "number", "format": "double" }, @@ -13567,7 +13567,7 @@ ] }, "squared_mean": { - "description": "M2 for Welford's algorithm for variance calculation.\n\nRead more on Welford's algorithm at ", + "description": "M2 for Welford's algorithm for variance calculation.\n\nRead about [Welford's algorithm](https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Welford's_online_algorithm) for more information on the algorithm.", "type": "number", "format": "double" }, @@ -13647,7 +13647,7 @@ ] }, "squared_mean": { - "description": "M2 for Welford's algorithm for variance calculation.\n\nRead more on Welford's algorithm at ", + "description": "M2 for Welford's algorithm for variance calculation.\n\nRead about [Welford's algorithm](https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Welford's_online_algorithm) for more information on the algorithm.", "type": "number", "format": "double" }, @@ -13729,7 +13729,7 @@ ] }, "squared_mean": { - "description": "M2 for Welford's algorithm for variance calculation.\n\nRead more on Welford's algorithm at ", + "description": "M2 for Welford's algorithm for variance calculation.\n\nRead about [Welford's algorithm](https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Welford's_online_algorithm) for more information on the algorithm.", "type": "number", "format": "double" }, @@ -13811,7 +13811,7 @@ ] }, "squared_mean": { - "description": "M2 for Welford's algorithm for variance calculation.\n\nRead more on Welford's algorithm at ", + "description": "M2 for Welford's algorithm for variance calculation.\n\nRead about [Welford's algorithm](https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Welford's_online_algorithm) for more information on the algorithm.", "type": "number", "format": "double" }, @@ -13893,7 +13893,7 @@ ] }, "squared_mean": { - "description": "M2 for Welford's algorithm for variance calculation.\n\nRead more on Welford's algorithm at ", + "description": "M2 for Welford's algorithm for variance calculation.\n\nRead about [Welford's algorithm](https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Welford's_online_algorithm) for more information on the algorithm.", "type": "number", "format": "double" }, @@ -13975,7 +13975,7 @@ ] }, "squared_mean": { - "description": "M2 for Welford's algorithm for variance calculation.\n\nRead more on Welford's algorithm at ", + "description": "M2 for Welford's algorithm for variance calculation.\n\nRead about [Welford's algorithm](https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Welford's_online_algorithm) for more information on the algorithm.", "type": "number", "format": "double" }, diff --git a/oximeter/oximeter/src/histogram.rs b/oximeter/oximeter/src/histogram.rs index 2e185145052..25e42a3d3bf 100644 --- a/oximeter/oximeter/src/histogram.rs +++ b/oximeter/oximeter/src/histogram.rs @@ -378,8 +378,8 @@ where sum_of_samples: T::Width, /// M2 for Welford's algorithm for variance calculation. /// - /// Read more on Welford's algorithm at - /// + /// Read about [Welford's algorithm](https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Welford's_online_algorithm) + /// for more information on the algorithm. squared_mean: f64, /// p50 Quantile p50: Quantile, diff --git a/oximeter/oximeter/src/quantile.rs b/oximeter/oximeter/src/quantile.rs index 0e18f65fe66..310ed525c0e 100644 --- a/oximeter/oximeter/src/quantile.rs +++ b/oximeter/oximeter/src/quantile.rs @@ -10,7 +10,8 @@ //! a very small and fixed storage requirement regardless of the //! number of observations. //! -//! Read for more. +//! Read the [paper](https://www.cs.wustl.edu/~jain/papers/ftp/psqr.pdf) +//! for more specifics. // Copyright 2024 Oxide Computer Company