Skip to content

Commit 464bcad

Browse files
committed
much grammar such fix
1 parent f91aa06 commit 464bcad

File tree

1 file changed

+42
-42
lines changed

1 file changed

+42
-42
lines changed

README.rst

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -39,55 +39,55 @@
3939
**Data Version Control** or **DVC** is an **open-source** tool for data science and machine
4040
learning projects. Key features:
4141

42-
#. simple **command line** Git-like experience. Does not require installing and maintaining
43-
any databases. Does not depend on any proprietary online services;
42+
#. Simple **command line** Git-like experience. Does not require installing and maintaining
43+
any databases. Does not depend on any proprietary online services.
4444

45-
#. it manages and versions **datasets** and **machine learning models**. Data is saved in
46-
S3, Google cloud, Azure, Alibaba cloud, SSH server, HDFS or even local HDD RAID;
45+
#. Management and versioning of **datasets** and **machine learning models**. Data is saved in
46+
S3, Google cloud, Azure, Alibaba cloud, SSH server, HDFS, or even local HDD RAID.
4747

48-
#. it makes projects **reproducible** and **shareable**, it helps answering question how
49-
the model was build;
48+
#. Makes projects **reproducible** and **shareable**; helping to answer questions about how
49+
a model was built.
5050

51-
#. it helps manage experiments with Git tags or branches and **metrics** tracking;
51+
#. Helps manage experiments with Git tags/branches and **metrics** tracking.
5252

53-
**DVC** aims to replace tools like Excel and Google Docs that are being commonly used as a knowledge repo and
54-
a ledger for the team, ad-hoc scripts to track and move deploy different model versions, ad-hoc
55-
data file suffixes and prefixes.
53+
**DVC** aims to replace spreadsheet and document sharing tools (such as Excel or Google Docs)
54+
which are being used frequently as both knowledge repositories and team ledgers.
55+
DVC also replaces both ad-hoc scripts to track, move, and deploy different model versions;
56+
as well as ad-hoc data file suffixes and prefixes.
5657

5758
.. contents:: **Contents**
5859
:backlinks: none
5960

6061
How DVC works
6162
=============
6263

63-
We encourage you to read our `Get Started <https://dvc.org/doc/get-started>`_ to better understand what DVC
64-
is and how does it fit your scenarios.
64+
We encourage you to read our `Get Started <https://dvc.org/doc/get-started>`_ guide to better understand what DVC
65+
is and how it can fit your scenarios.
6566

66-
The easiest (but not perfect!) *analogy* to describe it: DVC is Git (or Git-lfs to be precise) + ``makefiles``
67+
The easiest (but not perfect!) *analogy* to describe it: DVC is Git (or Git-LFS to be precise) & ``Makefile``s
6768
made right and tailored specifically for ML and Data Science scenarios.
6869
69-
#. ``Git/Git-lfs`` part - DVC helps you storing and sharing data artifacts, models. It connects them with your
70-
Git repository.
71-
#. ``Makefiles`` part - DVC describes how one data or model artifact was build from another data.
70+
#. ``Git/Git-LFS`` part - DVC helps store and share data artifacts and models, connecting them with a Git repository.
71+
#. ``Makefiles`` part - DVC describes how one data or model artifact was built from other data and code.
7272

73-
DVC usually runs along with Git. Git is used as usual to store and version code and DVC meta-files. DVC helps
74-
to store data and model files seamlessly out of Git while preserving almost the same user experience as if they
75-
were stored in Git itself. To store and share data files cache DVC supports remotes - any cloud (S3, Azure,
73+
DVC usually runs along with Git. Git is used as usual to store and version code (including DVC meta-files). DVC helps
74+
to store data and model files seamlessly out of Git, while preserving almost the same user experience as if they
75+
were stored in Git itself. To store and share the data cache, DVC supports multiple remotes - any cloud (S3, Azure,
7676
Google Cloud, etc) or any on-premise network storage (via SSH, for example).
7777

7878
.. image:: https://dvc.org/static/img/flow.gif
7979
:target: https://dvc.org/static/img/flow.gif
8080
:alt: how_dvc_works
8181

82-
DVC pipelines (aka computational graph) feature connects code and data together. In a very explicit way you can
83-
specify, run, and save information that a certain command with certain dependencies needs to be run to produce
84-
a model. See the quick start section below or check `Get Started <https://dvc.org/doc/get-started>`_ tutorial to
85-
learn more.
82+
The DVC pipelines (computational graph) feature connects code and data together. It is possible to explicitly
83+
specify all steps required to produce a model: input dependencies including data, commands to run,
84+
and output information to be saved. See the quick start section below or
85+
the `Get Started <https://dvc.org/doc/get-started>`_ tutorial to learn more.
8686

8787
Quick start
8888
===========
8989

90-
Please read `Get Started <https://dvc.org/doc/get-started>`_ for the full version. Common workflow commands include:
90+
Please read `Get Started <https://dvc.org/doc/get-started>`_ guide for a full version. Common workflow commands include:
9191

9292
+-----------------------------------+-------------------------------------------------------------------+
9393
| Step | Command |
@@ -112,8 +112,8 @@ Please read `Get Started <https://dvc.org/doc/get-started>`_ for the full versio
112112
Installation
113113
============
114114

115-
Read this `instruction <https://dvc.org/doc/get-started/install>`_ to get more details. There are four
116-
options to install DVC: ``pip``, Homebrew, Conda (Anaconda) or an OS-specific package:
115+
There are four options to install DVC: ``pip``, Homebrew, Conda (Anaconda) or an OS-specific package.
116+
Full instructions are `available here <https://dvc.org/doc/get-started/install>`_.
117117

118118
pip (PyPI)
119119
----------
@@ -124,8 +124,8 @@ pip (PyPI)
124124
125125
Depending on the remote storage type you plan to use to keep and share your data, you might need to specify
126126
one of the optional dependencies: ``s3``, ``gs``, ``azure``, ``oss``, ``ssh``. Or ``all`` to include them all.
127-
The command should look like this: ``pip install dvc[s3]`` - it installs the ``boto3`` library along with
128-
DVC to support the AWS S3 storage.
127+
The command should look like this: ``pip install dvc[s3]`` (in this case AWS S3 dependencies such as ``boto3``
128+
will be installed automatically).
129129

130130
To install the development version, run:
131131

@@ -148,7 +148,7 @@ Conda (Anaconda)
148148
149149
conda install -c conda-forge dvc
150150
151-
Currently, it supports only python version 2.7, 3.6 and 3.7.
151+
Currently, this includes support for Python versions 2.7, 3.6 and 3.7.
152152

153153
Snap (Snapcraft)
154154
----------------
@@ -168,8 +168,8 @@ there will be no need to download ``dvc_*.snap`` or use ``--dangerous``
168168
Package
169169
-------
170170

171-
Self-contained packages for Windows, Linux, Mac are available. The latest version of the packages can be found at
172-
GitHub `releases page <https://github.com/iterative/dvc/releases>`_.
171+
Self-contained packages for Linux, Windows, and Mac are available. The latest version of the packages
172+
can be found on the GitHub `releases page <https://github.com/iterative/dvc/releases>`_.
173173

174174
Ubuntu / Debian (deb)
175175
^^^^^^^^^^^^^^^^^^^^^
@@ -187,23 +187,23 @@ Fedora / CentOS (rpm)
187187
sudo yum update
188188
sudo yum install dvc
189189
190-
Related technologies
191-
====================
190+
Comparison to related technologies
191+
==================================
192192

193-
#. `Git-annex <https://git-annex.branchable.com/>`_ - DVC uses the idea of storing the content of large files (that you
194-
don't want to see in your Git repository) in a local key-value store and uses file hardlinks/symlinks instead of the
195-
copying actual files.
193+
#. `Git-annex <https://git-annex.branchable.com/>`_ - DVC uses the idea of storing the content of large files (which should
194+
not be in a Git repository) in a local key-value store, and uses file hardlinks/symlinks instead of
195+
copying/duplicating files.
196196

197197
#. `Git-LFS <https://git-lfs.github.com/>`_ - DVC is compatible with any remote storage (S3, Google Cloud, Azure, SSH,
198-
etc). DVC utilizes reflinks or hardlinks to avoid copy operation on checkouts which makes much more efficient for
199-
large data files.
198+
etc). DVC also uses reflinks or hardlinks to avoid copy operations on checkouts; thus handling large data files
199+
much more efficiently.
200200

201-
#. *Makefile* (and its analogues). DVC tracks dependencies (DAG).
201+
#. *Makefile* (and analogues including ad-hoc scripts) - DVC tracks dependencies (in a directed acyclic graph).
202202

203-
#. `Workflow Management Systems <https://en.wikipedia.org/wiki/Workflow_management_system>`_. DVC is a workflow
203+
#. `Workflow Management Systems <https://en.wikipedia.org/wiki/Workflow_management_system>`_ - DVC is a workflow
204204
management system designed specifically to manage machine learning experiments. DVC is built on top of Git.
205205

206-
#. `DAGsHub <https://dagshub.com/>`_ Is a Github equivalent for DVC - pushing your Git+DVC based repo to DAGsHub will give you a high level dashboard of your project, including DVC pipeline and metrics visualizations, as well as links to DVC managed files if they are in cloud storage.
206+
#. `DAGsHub <https://dagshub.com/>`_ - This is a Github equivalent for DVC. Pushing Git+DVC based repositories to DAGsHub will produce in a high level project dashboard; including DVC pipelines and metrics visualizations, as well as links to any DVC-managed files present in cloud storage.
207207

208208
Contributing
209209
============
@@ -252,5 +252,5 @@ Copyright
252252

253253
This project is distributed under the Apache license version 2.0 (see the LICENSE file in the project root).
254254

255-
By submitting a pull request for this project, you agree to license your contribution under the Apache license version
255+
By submitting a pull request to this project, you agree to license your contribution under the Apache license version
256256
2.0 to this project.

0 commit comments

Comments
 (0)