add tods-doc

Former-commit-id: aa0fbbfa8d [formerly b5cad21c7c] [formerly 394bbe1a44 [formerly 8263e35ebf]] [formerly 5653f86ee7 [formerly c899ced951] [formerly 7409ccfee3 [formerly 1ad529fec8]]] [formerly d05f278dd8 [formerly 8c171a8453] [formerly b60105c6ac [formerly f739c114ab]] [formerly 44182fa37d [formerly 9d7bb95aa1] [formerly d2dcb1397a [formerly 6a43bf3f5b]]]] [formerly 375086a859 [formerly 4047374cc0] [formerly c2c7837e9d [formerly ceada18c79]] [formerly e45859bc02 [formerly 4bed72adf1] [formerly 4d24bcfabc [formerly 7f29cceaef]]] [formerly 2da08d7355 [formerly 087db90f34] [formerly 022417e379 [formerly 06cf78b84f]] [formerly 9d2a3ca4f1 [formerly 78fff3a810] [formerly 3447e940fe [formerly 5703f3e6ff]]]]] [formerly 477bdbef8b [formerly df49025cc3] [formerly 71235427de [formerly ac88cdb33f]] [formerly 2c80d8db18 [formerly 3adcc038ac] [formerly a19a2ec754 [formerly db9930d3e5]]] [formerly 366a956c69 [formerly 17bb182821] [formerly df9d588938 [formerly 383cba3bd0]] [formerly 257a3ed769 [formerly 2433e94fa5] [formerly d3bd7c161a [formerly e24940731e]]]] [formerly 1b3435a846 [formerly a79dd481b6] [formerly e73627be7c [formerly af057f14d2]] [formerly 0b0155ac60 [formerly b69e98f66b] [formerly 3f4063e14c [formerly 15ba1e2ea7]]] [formerly 3a28661591 [formerly 5e7e14de1e] [formerly 7449afaf60 [formerly fb0e8480d3]] [formerly 71160410a9 [formerly c47cf794ac] [formerly 838d249c47 [formerly 9ee0a0f72d]]]]]]
Former-commit-id: 08fcd82955 [formerly 7e9cf1a61c] [formerly 4a432587a2 [formerly 775f218595]] [formerly 09b4ddce78 [formerly af66dfc5c3] [formerly 2e4c583007 [formerly 469b1eee5b]]] [formerly c7d49328b8 [formerly b875cde3cd] [formerly 523d76ba51 [formerly eb8f17193b]] [formerly e2caae1181 [formerly 4c93000c68] [formerly 9746f04e05 [formerly 4da698d09e]]]] [formerly 83a4223a35 [formerly 11aaf8674c] [formerly c46e0397b7 [formerly 96eda8f3f5]] [formerly 666fa7bfd5 [formerly 5526af3d9c] [formerly 60f28f92dc [formerly 67bd35682a]]] [formerly 4da49c7f1c [formerly 682e7b0a31] [formerly 5e9b3d73a5 [formerly f8198453f6]] [formerly 97ac0a6ec6 [formerly cdd1e6ec97] [formerly 838d249c47]]]]
Former-commit-id: 4ab507bbd5 [formerly faabbf0abd] [formerly 80fd377184 [formerly bf2db8ce61]] [formerly a3be62f76b [formerly bd45862749] [formerly b54063cd14 [formerly b28e90c200]]] [formerly 35cafea769 [formerly cfef1b44ac] [formerly 345c86856d [formerly c61b1d383f]] [formerly a2b2f62fad [formerly 02c1137412] [formerly 5e152f6ffc [formerly 30dd804c24]]]]
Former-commit-id: 3580227766 [formerly b8d559fafe] [formerly 9cc995202d [formerly 6f91330879]] [formerly 5e74833eb3 [formerly 9bba217c60] [formerly fdd29d34bf [formerly b2bd252fae]]]
Former-commit-id: ffb523cb47 [formerly f7bbfd739d] [formerly f588ea566d [formerly 0bfb289efd]]
Former-commit-id: 5528a261c0 [formerly 0e8e66f928]
Former-commit-id: f6140f8a5a

README.md

@@ -21,7 +21,14 @@ This package works with **Python 3.6** and pip 19+. You need to have the followi
 sudo apt-get install libssl-dev libcurl4-openssl-dev libyaml-dev build-essential libopenblas-dev libcap-dev ffmpeg
 ```
 
-Then execute `python setup.py install`, the script will then install all of the packges to build up TODS.
+Clone the repository:
+```
+git clone https://github.com/datamllab/tods.git
+```
+Install locally with `pip`:
+```
+pip install -e .
+```
 
 # Examples
 Examples are available in [/examples](examples/). For basic usage, you can evaluate a pipeline on a given datasets. Here, we provide an example to load our default pipeline and evaluate it on a subset of yahoo dataset.