From 58f747ce5d7d199409d00b6aff3120b2fa6b35d9 Mon Sep 17 00:00:00 2001 From: Ruslan Kuprieiev Date: Thu, 22 Mar 2018 20:52:24 +0200 Subject: [PATCH] readme: Use proper rst formatting Signed-off-by: Ruslan Kuprieiev --- README.rst | 44 +++++++++++++++++++++----------------------- 1 file changed, 21 insertions(+), 23 deletions(-) diff --git a/README.rst b/README.rst index aa44d800b..c8959399e 100644 --- a/README.rst +++ b/README.rst @@ -1,41 +1,39 @@ -.. image:: https://travis-ci.org/dataversioncontrol/dvc.svg?branch=master +.. image:: https://img.shields.io/travis/dataversioncontrol/dvc/master.svg?label=Linux%20%26%20Mac%20OS :target: https://travis-ci.org/dataversioncontrol/dvc - :alt: Linux & Mac OS -.. image:: https://ci.appveyor.com/api/projects/status/rnqygb4rp1tsjvhb/branch/master?svg=true +.. image:: https://img.shields.io/appveyor/ci/dataversioncontrol/dvc/master.svg?label=Windows :target: https://ci.appveyor.com/project/dataversioncontrol/dvc/branch/master - :alt: Windows .. image:: https://codeclimate.com/github/dataversioncontrol/dvc/badges/gpa.svg :target: https://codeclimate.com/github/dataversioncontrol/dvc - :alt: Code quality .. image:: https://codecov.io/gh/dataversioncontrol/dvc/branch/master/graph/badge.svg :target: https://codecov.io/gh/dataversioncontrol/dvc - :alt: Test coverage Data Version Control or DVC is an open source tool for data science projects. It helps data scientists manage their code and data together in a simple form of Git-like commands. Get started =========== - -.. list-table:: - :header-rows: 1 - - * - Step - - Command - * - Track code and data together - - ``$ git add train.py`` :raw-html-m2r:`
` ``$ dvc add images.zip`` - * - Connect code and data by commands - - ``$ dvc run -d images.zip -o images/ unzip -q images.zip`` :raw-html-m2r:`
` ``$ dvc run -d images/ -d train.py -o model.p python train.py`` - * - Make changes and reproduce - - ``$ vi train.py`` :raw-html-m2r:`
` ``$ dvc repro model.p.dvc`` - * - Share code - - ``$ git add .`` :raw-html-m2r:`
` ``$ git commit -m 'The baseline model'`` :raw-html-m2r:`
` ``$ git push`` - * - Share data and ML models - - ``$ dvc config AWS.StoragePath mybucket/image_cnn`` :raw-html-m2r:`
` ``$ dvc push`` - ++-----------------------------------+-------------------------------------------------------------------+ +| Step | Command | ++===================================+===================================================================+ +| Track code and data together | | ``$ 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 config AWS.StoragePath mybucket/image_cnn`` | +| | | ``$ dvc push`` | ++-----------------------------------+-------------------------------------------------------------------+ See more in `tutorial `_.