PyPI/jumpavg/README.md

   1 # Jumpavg library
   2
   3 ## Origins
   4
   5 This library was developed as anomaly detection logic
   6 for [PAL](https://wiki.fd.io/view/CSIT/Design_Optimizations#Presentation_and_Analytics_Layer "Presentation and Analysis Layer")
   7 of [CSIT](https://wiki.fd.io/view/CSIT "Continuous System and Integration Testing")
   8 project of [fd.io](https://fd.io/ "Fast Data"),
   9 one of [LFN](https://www.linuxfoundation.org/projects/networking/ "Linux Foundation Networking") projects.
  10
  11 Currently still being primarily used in PAL's successor [CSIT-DASH](https://csit.fd.io).
  12
  13 In order to make this code available in [PyPI](https://pypi.org/ "Python Package Index"),
  14 the setuputils stuff has been added,
  15 and the code has been moved into a separate [directory](https://gerrit.fd.io/r/gitweb?p=csit.git;a=tree;f=PyPI/jumpavg),
  16 in order to not intervere of otherwise tightly coupled CSIT code.
  17
  18 ## Usage
  19
  20 TODO.
  21
  22 ## Change log
  23
  24 TODO: Move into a separate file?
  25
  26 + 0.4.0: Added "unit" and "sbps" parameters so information content
  27   is reasonable even if sample values are below one.
  28
  29 + 0.3.0: Considerable speedup by avoiding unneeded copy. Dataclasses used.
  30   Mostly API compatible, but repr looks different.
  31
  32 + 0.2.0: API incompatible changes. Targeted to Python 3 now.
  33
  34 + 0.1.3: Changed stdev computation to avoid negative variance due to rounding errors.
  35
  36 + 0.1.2: First version published in PyPI.