diff --git a/README.md b/README.md index c91ddbc3dad7cb79dc0bc6ca9fef100a5cc7dd88..47a53bf019219f0d1cc6f1df16a629b45229b17d 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,37 @@ Should be available by default on the IC Cluster. Otherwise, refer to each project installation instructions. +# Dataset + +Download the ````ml-100k.zip```` dataset in the ````data/```` folder: +```` +> mkdir data +> cd data +> wget http://files.grouplens.org/datasets/movielens/ml-100k.zip +```` + +Check the integrity of the file with (it should give the same number as below): +```` +> md5 -q ml-100k.zip +0e33842e24a9c977be4e0107933c0723 +```` + +Unzip: +```` +> unzip ml-100k.zip +```` + # Usage ## Compute predictions ```` - sbt 'runMain predict.Predictor' +> sbt 'runMain predict.Predictor' ```` ## Compute recommendations ```` - sbt 'runMain recommend.Recommender' +> sbt 'runMain recommend.Recommender' ```` ## Package for submission @@ -25,7 +45,7 @@ Update the ````name````, ````maintainer```` fields of ````build.sbt````, with th Package your application: ```` - sbt 'show dist' +> sbt 'show dist' ```` You should should see an output like: @@ -33,7 +53,7 @@ You should should see an output like: [info] Your package is ready in [...]/target/universal/m1_your_id-1.0.zip ```` -Combine this package, along side your report and any other files mentioned in the Milestone description (see Section ````Deliverables````). Submit to the TA for grading. +Combine this package, alongside your report and any other files mentioned in the Milestone description (see Section ````Deliverables````). Submit to the TA for grading. # References