Skip to content

Commit 31c79be

Browse files
committed
add preprint, add relative links to README
1 parent 6fbd7d7 commit 31c79be

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

docs/asymmetric/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@ This directory contains some empirical results of constructing t-digests with as
22
which may be of particular interest for distributions with substantial skew. Suitable asymmetric scale functions
33
can be obtained by gluing the familiar k<sub>1</sub>, k<sub>2</sub>, k<sub>3</sub> to their tangent lines at some point p in (0, 1).
44
A theoretical justification for this construction (namely, the proofs that the modified scale functions produce
5-
mergeable data structures that can operate online), together with these results, will be submitted for publication shortly.
5+
mergeable data structures that can operate online), together with these results, is contained in a preprint
6+
"Asymmetric scale functions for t-digests." The preprint is available in this repository [here](../proofs/gluing-construction.pdf)
7+
and at https://arxiv.org/abs/2005.09599, and has been submitted for publication.
68

79
The main goal here is to compare the usual scale functions with their asymmetric counterparts (using the point p=1/2 as a gluing location),
810
both in terms of accuracy and memory consumption (via number of centroids). A quadratic scale function is considered as well.
@@ -15,20 +17,19 @@ The data and summarizing plots can be produced in two steps.
1517

1618
### Generate data
1719

18-
In `TDigestTests.java`, run `writeUniformResultsWithCompression` with the `ALVTreeDigest` implementation, i.e., run
20+
In [TDigestTests](../../core/src/test/java/com/tdunning/math/stats/TDigestTest.java), run `writeUniformResultsWithCompression` with the `ALVTreeDigest` implementation, i.e., run
1921
`AVLTreeDigestTest.writeUniformResultsWithCompression`.
2022

21-
In `MergingDigestTest.java`, run `writeAsymmetricScaleFunctionResults`.
23+
In [MergingDigestTest](../../core/src/test/java/com/tdunning/math/stats/MergingDigestTest.java), run `writeAsymmetricScaleFunctionResults`.
2224

23-
These will write data files to subdirectories of the `data` directory of `asymmetric`.
24-
The data so generated is already present.
25+
These will write data files.
2526

2627

2728
### Generate plots
2829

29-
Now run the script `generate_plots.py` located in this directory.
30+
Now run the script [generate_plots.py](./generate_plots.py).
3031

3132
This script expects to be present the results of running the tests as above.
32-
It will write plots (as PNG files) to subdirectories of the `plots` directory.
33-
The figures so generated are already present.
34-
33+
It will write plots (as PNG files).
34+
The figures so generated are already present in this repository, see [here](../asymmetric/plots/merging/t_digest_figs_K_0q.png)
35+
and [here](../asymmetric/plots/tree/t_digest_figs_K_0q.png) for example.
756 KB
Binary file not shown.

0 commit comments

Comments
 (0)