diff --git a/README.rst b/README.rst index 82e96d1e9..042d216b1 100644 --- a/README.rst +++ b/README.rst @@ -66,25 +66,25 @@ Quick start Please read `Get Started `_ guide for a full version. Common workflow commands include: -+-----------------------------------+-------------------------------------------------------------------+ -| Step | Command | -+===================================+===================================================================+ -| Track data | | ``$ git add train.py`` | -| | | ``$ dvc add images.zip`` | -+-----------------------------------+-------------------------------------------------------------------+ -| Connect code and data by commands | | ``$ dvc run -d images.zip -o images/ unzip -q images.zip`` | -| | | ``$ dvc run -d images/ -d train.py -o model.p python train.py`` | -+-----------------------------------+-------------------------------------------------------------------+ -| Make changes and reproduce | | ``$ vi train.py`` | -| | | ``$ dvc repro model.p.dvc`` | -+-----------------------------------+-------------------------------------------------------------------+ -| Share code | | ``$ git add .`` | -| | | ``$ git commit -m 'The baseline model'`` | -| | | ``$ git push`` | -+-----------------------------------+-------------------------------------------------------------------+ -| Share data and ML models | | ``$ dvc remote add myremote -d s3://mybucket/image_cnn`` | -| | | ``$ dvc push`` | -+-----------------------------------+-------------------------------------------------------------------+ ++-----------------------------------+----------------------------------------------------------------------------+ +| Step | Command | ++===================================+============================================================================+ +| Track data | | ``$ git add train.py`` | +| | | ``$ dvc add images.zip`` | ++-----------------------------------+----------------------------------------------------------------------------+ +| Connect code and data by commands | | ``$ dvc run -n prepare -d images.zip -o images/ unzip -q images.zip`` | +| | | ``$ dvc run -n train -d images/ -d train.py -o model.p python train.py`` | ++-----------------------------------+----------------------------------------------------------------------------+ +| Make changes and reproduce | | ``$ vi train.py`` | +| | | ``$ dvc repro model.p.dvc`` | ++-----------------------------------+----------------------------------------------------------------------------+ +| Share code | | ``$ git add .`` | +| | | ``$ git commit -m 'The baseline model'`` | +| | | ``$ git push`` | ++-----------------------------------+----------------------------------------------------------------------------+ +| Share data and ML models | | ``$ dvc remote add myremote -d s3://mybucket/image_cnn`` | +| | | ``$ dvc push`` | ++-----------------------------------+----------------------------------------------------------------------------+ Installation ============