Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
ASolomatin committed Sep 6, 2023
1 parent 43f5f12 commit f662976
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,39 @@
[test-icon]: https://github.com/ASolomatin/T-Digest.NET/actions/workflows/tests.yml/badge.svg?branch=main
[test-url]: https://github.com/ASolomatin/T-Digest.NET/actions/workflows/tests.yml

[packaging-icon]: https://github.com/ASolomatin/T-Digest.NET/actions/workflows/publish.yml/badge.svg
[packaging-url]: https://github.com/ASolomatin/T-Digest.NET/actions/workflows/publish.yml

[license-icon]: https://img.shields.io/github/license/ASolomatin/T-Digest.NET
[license-url]: https://github.com/ASolomatin/T-Digest.NET/blob/master/LICENSE

[nuget-icon]: https://img.shields.io/nuget/v/T-Digest.NET.svg
[nuget-downloads-icon]: https://img.shields.io/nuget/dt/T-Digest.NET.svg
[nuget-url]: https://www.nuget.org/packages/T-Digest.NET

# T-Digest.NET

[![NuGet][nuget-icon]][nuget-url]
[![NuGet downloads][nuget-downloads-icon]][nuget-url]
[![Tests][test-icon]][test-url]
[![Publish][packaging-icon]][packaging-url]
[![GitHub][license-icon]][license-url]

----------------------------------------

.NET Implementation of the relatively new T-Digest quantile estimation algorithm. Useful for calculating highly accurate Quantiles or Percentiles from on-line streaming data, or data-sets that are too large to store in memory and sort, which is required to calculate the true quantile.

Fully refactored fork of [quantumtunneling/T-Digest.NET](https://github.com/quantumtunneling/T-Digest.NET) with next changes:
- Modern .NET frameworks support
- Highly improved performance
- A bit better accuracy

<!-- The Nuget package for this Implementation can be found [here](https://www.nuget.org/packages/) -->
The Nuget package for this Implementation can be found [here](https://www.nuget.org/packages/T-Digest.NET)

The T-Digest white paper can be found [here](https://github.com/tdunning/t-digest/blob/master/docs/t-digest-paper/histo.pdf)

----------------------------------------

Example Code:
```csharp
using TDigestNet;
Expand All @@ -31,3 +55,11 @@ Example Code:
Console.WriteLine($"Percentile 80: {digest.Quantile(80 / 100d)}");
Console.WriteLine($"Percentile 99: {digest.Quantile(99 / 100d)}");
```

----------------------------------------

## License

**[MIT][license-url]**

Copyright (C) 2023 Aleksej Solomatin

0 comments on commit f662976

Please sign in to comment.