PyPI/MLRsearch/README.rst

   1 Multiple Loss Ratio Search library
   2 ==================================
   3
   4 Origins
   5 -------
   6
   7 This library was developed as a speedup for traditional binary search
   8 in CSIT_ (Continuous System and Integration Testing) project of fd.io_
   9 (Fast Data), one of LFN_ (Linux Foundation Networking) projects.
  10
  11 In order to make this code available in PyPI_ (Python Package Index),
  12 the setuputils stuff has been added,
  13 but after some discussion, the export directory_
  14 is only a symlink to the original place of tightly coupled CSIT code.
  15
  16 Change log
  17 ----------
  18
  19 0.4.0: Considarable logic improvements, more than two target ratios supported.
  20 API is not backward compatible with previous versions.
  21
  22 0.3.0: Migrated to Python 3.6, small code quality improvements.
  23
  24 0.2.0: Optional parameter "doublings" has been added.
  25
  26 0.1.1: First officially released version.
  27
  28 Usage
  29 -----
  30
  31 TODO.
  32
  33 Operation logic
  34 ---------------
  35
  36 The latest published `IETF draft`_ describes logic of version 0.3,
  37 version 0.4 logic will be descibed in next draft version.
  38
  39 .. _CSIT: https://wiki.fd.io/view/CSIT
  40 .. _fd.io: https://fd.io/
  41 .. _LFN: https://www.linuxfoundation.org/projects/networking/
  42 .. _PyPI: https://pypi.org/project/MLRsearch/
  43 .. _directory: https://gerrit.fd.io/r/gitweb?p=csit.git;a=tree;f=PyPI/MLRsearch;hb=refs/heads/master
  44 .. _IETF draft: https://tools.ietf.org/html/draft-ietf-bmwg-mlrsearch-00