CSIT-1222: Edit MLRsearch readme for 0.2.0 release
[csit.git] / 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.2.0: Optional parameter "doublings" has been added.
20
21 0.1.1: First officially released version.
22
23 Usage
24 -----
25
26 TODO.
27
28 Operation logic
29 ---------------
30
31 TODO.
32
33 .. _CSIT: https://wiki.fd.io/view/CSIT
34 .. _fd.io: https://fd.io/
35 .. _LFN: https://www.linuxfoundation.org/projects/networking/
36 .. _PyPI: https://pypi.org/
37 .. _directory: https://gerrit.fd.io/r/gitweb?p=csit.git;a=tree;f=PyPI/MLRsearch;hb=refs/heads/master