PyPI/jumpavg/README.rst

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