Gagan Bhatia commited on
Commit
796df4b
1 Parent(s): ee5ec15

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -0
README.md CHANGED
@@ -8,3 +8,11 @@ Instructions
8
  1. Clone the repo.
9
  1. Run `make dirs` to create the missing parts of the directory structure described below.
10
  1. *Optional:* Run `make virtualenv` to create a python virtual environment. Skip if using conda or some other env manager.
 
 
 
 
 
 
 
 
 
8
  1. Clone the repo.
9
  1. Run `make dirs` to create the missing parts of the directory structure described below.
10
  1. *Optional:* Run `make virtualenv` to create a python virtual environment. Skip if using conda or some other env manager.
11
+ 1. Run `source env/bin/activate` to activate the virtualenv.
12
+ 1. Run `make requirements` to install required python packages.
13
+ 1. Put the raw data in `data/raw`.
14
+ 1. To save the raw data to the DVC cache, run `dvc commit raw_data.dvc`
15
+ 1. Edit the code files to your heart's desire.
16
+ 1. Process your data, train and evaluate your model using `dvc repro eval.dvc` or `make reproduce`
17
+ 1. When you're happy with the result, commit files (including .dvc files) to git.
18
+