Merge branch 'master' of https://github.com/wnzhang/make-ipinyou-data

APEXLAB · Oct 9, 2014 · eb88704 · eb88704
2 parents 5a974bc + 1361202
commit eb88704
Showing 1 changed file with 26 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -3,15 +3,33 @@ make-ipinyou-data
 
 This project is to formalise the iPinYou RTB data into a standard format for further researches.
 
-0. Go to http://data.computational-advertising.org to download ipinyou.contest.dataset.zip. Unzip it and get the folder ipinyou.contest.dataset.
-
-1. update the soft link for the folder 'ipinyou.contest.dataset' in 'original-data'. 
+### Step 0
+Go to [data.computational-advertising.org](http://data.computational-advertising.org) to download `ipinyou.contest.dataset.zip`. Unzip it and get the folder `ipinyou.contest.dataset`.
 
+### Step 1
+Update the soft link for the folder `ipinyou.contest.dataset` in `original-data`. 
+```
 weinan@ZHANG:~/Project/make-ipinyou-data/original-data$ ln -sfn ~/Data/ipinyou.contest.dataset ipinyou.contest.dataset
-
-
-
-
-2. just run make all.
+```
+Under `make-ipinyou-data/original-data/ipinyou.contest.dataset` there should be the original dataset files like this:
+```
+weinan@ZHANG:~/Project/make-ipinyou-data/original-data/ipinyou.contest.dataset$ ls
+algo.submission.demo.tar.bz2  README         testing2nd   training3rd
+city.cn.txt                   region.cn.txt  testing3rd   user.profile.tags.cn.txt
+city.en.txt                   region.en.txt  training1st  user.profile.tags.en.txt
+files.md5                     testing1st     training2nd
+```
+You do not need to further unzip the packages in the subfolders.
+
+### Step 2
+Under `make-ipinyou-data` folder, just run `make all`.
+
+After the program finished, the total size of the folder will be 14G. The files under `make-ipinyou-data` should be like this:
+```
+weinan@ZHANG:~/Project/make-ipinyou-data$ ls
+1458  2261  2997  3386  3476  LICENSE   mkyzxdata.sh   python     schema.txt
+2259  2821  3358  3427  all   Makefile  original-data  README.md
+```
+Normally, we only do experiment for each campaign (e.g. `1458`). `all` is just the merge of all the campaigns. You can delete `all` if you think it is unuseful in your experiment.
 
 For any questions, please report the issues or contact Weinan Zhang. Email: w.zhang@cs.ucl.ac.uk