Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

regular updates (early Oct) (3) #669

Merged
merged 5 commits into from
Oct 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
example: "Fix #bugnum: Introduce the first version of the collection editor.".

- Please make sure to mention "Fix #bugnum" (if applicable) somewhere in the
description of the PR. This enables Github to link the PR to the corresponding
description of the PR. This enables GitHub to link the PR to the corresponding
bug.
12 changes: 6 additions & 6 deletions pages/features.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export default () => (
<Name>Git-compatible</Name>
<Description>
DVC runs on top of any Git repository and is compatible with any
standard Git server or provider (Github, Gitlab, etc). Data file
standard Git server or provider (GitHub, GitLab, etc). Data file
contents can be shared by network-accessible storage or any
supported cloud solution. DVC offers all the advantages of a
distributed version control system — lock-free, local branching, and
Expand Down Expand Up @@ -63,7 +63,7 @@ export default () => (
alt="Reproducibility"
/>
</Icon>
<Name>Reproducible </Name>
<Name>Reproducible</Name>
<Description>
The single 'dvc repro' command reproduces experiments end-to-end.
DVC guarantees reproducibility by consistently maintaining a
Expand All @@ -78,7 +78,7 @@ export default () => (
alt="Low-friction branching"
/>
</Icon>
<Name>Low friction branching </Name>
<Name>Low friction branching</Name>
<Description>
DVC fully supports instantaneous Git branching, even with large
files. Branches beautifully reflect the non-linear structure and
Expand All @@ -92,7 +92,7 @@ export default () => (
<Icon>
<img src="/static/img/features/icons/storage-icon.svg" alt="" />
</Icon>
<Name>Metric tracking </Name>
<Name>Metric tracking</Name>
<Description>
Metrics are first-class citizens in DVC. DVC includes a command to
list all branches, along with metric values, to track the progress
Expand Down Expand Up @@ -154,8 +154,8 @@ export default () => (
</Icon>
<Name>Track failures</Name>
<Description>
Bad ideas can sometimes bring more information to colleagues than
the successful ones. Retaining knowledge of failed attempts can save
Bad ideas can sometimes spark more ideas among colleagues than
successful ones. Retaining knowledge of failed attempts can save
time in the future. DVC is built to track everything in a
reproducible and easily accessible way.
</Description>
Expand Down
2 changes: 1 addition & 1 deletion src/Documentation/Markdown/Markdown.js
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ export default class Markdown extends React.PureComponent {
return (
<Content>
<GithubLink href={githubLink} target="_blank">
<i /> Edit on Github
<i /> Edit on GitHub
</GithubLink>
<ReactMarkdown
key={githubLink}
Expand Down
2 changes: 1 addition & 1 deletion src/Documentation/RightPanel/RightPanel.js
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ export default class RightPanel extends React.PureComponent {

<GithubButton href={githubLink} target="_blank">
<i />
Edit on Github
Edit on GitHub
</GithubButton>

<br />
Expand Down
2 changes: 1 addition & 1 deletion src/Footer/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ export default function Footer(props) {
src="/static/img/github.png"
href="https://github.com/iterative/dvc"
>
Github
GitHub
</SocialLink>
<SocialLink src="/static/img/discord.png" href="/chat">
Discord
Expand Down
2 changes: 1 addition & 1 deletion src/GithubLine/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export default class GithubLine extends Component {
<Wrapper>
<Github src="/static/img/github_small.png" width="20" height="20" />
We’re on
<Link href={gh}>Github</Link>
<Link href={gh}>GitHub</Link>
<Star
src="/static/img/star_small.svg"
width="11.74"
Expand Down
2 changes: 1 addition & 1 deletion src/HamburgerMenu/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ export default class HamburgerMenu extends Component {
href="https://github.com/iterative/dvc"
click={this.itemClick('github')}
>
Github
GitHub
</SocialLink>
<SocialLink
src="/static/img/discord.png"
Expand Down
4 changes: 2 additions & 2 deletions src/Nav/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export default function Nav({ mobile = false }) {
logEvent('menu', 'github')
}}
>
Github
GitHub
</Link>
<Link
href="/support"
Expand Down Expand Up @@ -111,7 +111,7 @@ const Wrapper = styled.div`
!props.mobile &&
`
display: none;
`}
`}
`};
`

Expand Down
8 changes: 4 additions & 4 deletions src/UseCases/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ const Heading3 = () => (

const Description1 = () => (
<Description>
At any time, fetch the full context about any experiment you or your team
has run. DVC guarantees that all files and metrics will be consistent and in
the right place to reproduce the experiment or use it as a baseline for a
new iteration.
At any time, fetch the full context about any experiment you or your
colleagues have run. DVC guarantees that all files and metrics will be
consistent and in the right place to reproduce the experiment or use it as a
baseline for a new iteration.
</Description>
)

Expand Down
2 changes: 1 addition & 1 deletion static/docs/changelog/0.35.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ improvements) we have done in the last few months:

- 📖 The [Get Started](/doc/get-started/agenda) section has been simplified
(e.g. to use tags instead of branches) and extended. We have also prepared a
[DVC project on Github](https://github.com/iterative/example-get-started) that
[DVC project on GitHub](https://github.com/iterative/example-get-started) that
reflects the sequence of chapters in the “get started” guide. You can now
download the whole project and reproduce all the models.

Expand Down
2 changes: 1 addition & 1 deletion static/docs/command-reference/get-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Note that this command doesn't require an existing DVC project to run in. It's a
single-purpose command that can be used out of the box after installing DVC.

> See `dvc get` to download data or model files or directories from other DVC
> repositories (e.g. Github URLs).
> repositories (e.g. GitHub URLs).

DVC supports several types of (local or) remote locations (protocols):

Expand Down
2 changes: 1 addition & 1 deletion static/docs/command-reference/get.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# get

Download or copy file or directory from any <abbr>DVC project</abbr> in a Git
repository (e.g. hosted on Github) into the current working directory.
repository (e.g. hosted on GitHub) into the current working directory.

> Unlike `dvc import`, this command does not track the downloaded data files
> (does not create a DVC-file).
Expand Down
2 changes: 1 addition & 1 deletion static/docs/command-reference/import-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ imported, while `out` can be used to specify the (path and) file name desired
for the imported data file or directory in the workspace.

> See `dvc import` to download and tack data or model files or directories from
> other DVC repositories (e.g. Github URLs).
> other DVC repositories (e.g. GitHub URLs).

DVC supports [DVC-files](/doc/user-guide/dvc-file-format) that refer to data in
external locations, see
Expand Down
2 changes: 1 addition & 1 deletion static/docs/command-reference/import.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# import

Download or copy file or directory from any <abbr>DVC project</abbr> in a Git
repository (e.g. hosted on Github) into the <abbr>workspace</abbr>, and track
repository (e.g. hosted on GitHub) into the <abbr>workspace</abbr>, and track
changes in this [external dependency](/doc/user-guide/external-dependencies).
Creates a DVC-file.

Expand Down
4 changes: 2 additions & 2 deletions static/docs/command-reference/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@ $ dvc pull --all-branches --all-tags
## Example: Checkout both DVC and Git

Let's start our exploration with the impact of `dvc install` on the
`dvc checkout` command. Remember that switching from one Git version to another
(with `git checkout`) changes the set of
`dvc checkout` command. Remember that switching from one Git repository version
to another (with `git checkout`) changes the set of
[DVC-files](/doc/user-guide/dvc-file-format) in the project. This changes the
set of data files that should be located in the workspace (which can be achieved
with `dvc checkout`).
Expand Down
2 changes: 1 addition & 1 deletion static/docs/command-reference/remote/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ positional arguments:

What is data remote?

The same way as Github provides storage hosting for Git repositories, DVC
The same way as GitHub provides storage hosting for Git repositories, DVC
remotes provide a central place to keep and share data and model files. With
this remote storage, you can pull models and data files created by colleagues
without spending time and resources to build or process them locally. It also
Expand Down
2 changes: 1 addition & 1 deletion static/docs/command-reference/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ system/environment:
> **Note** that if you've installed dvc using pip, you will need to install
> `psutil` by yourself with `pip install psutil` in order for `dvc version` to
> report file system information. Please see the original
> [issue on Github](https://github.com/iterative/dvc/issues/2284) for more info.
> [issue on GitHub](https://github.com/iterative/dvc/issues/2284) for more info.

#### Components of DVC version

Expand Down
2 changes: 1 addition & 1 deletion static/docs/get-started/agenda.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
In the next few sections we will build a simple natural language processing
(NLP) project from scratch. If you'd like to get the final result or have some
issues along the way, you can download the fully reproducible
[Github project](https://github.com/iterative/example-get-started) with:
[GitHub project](https://github.com/iterative/example-get-started) with:

```dvc
$ git clone https://github.com/iterative/example-get-started
Expand Down
2 changes: 1 addition & 1 deletion static/docs/get-started/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ immediately.
However, remote storage should be set up (see `dvc remote`) if you need to share
data or models outside of the context of a single project, for example with
other collaborators or even with yourself, in a different computing environment.
It's similar to the way you would use Github or any other Git server to store
It's similar to the way you would use GitHub or any other Git server to store
and share your code.

For simplicity, let's setup a local remote:
Expand Down
10 changes: 5 additions & 5 deletions static/docs/get-started/example-pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ of the data file itself.

The data file `Posts.xml.zip` is linked (or copied) from
`.dvc/cache/ce/68b98d82545628782c66192c96f2d2`, and added to `.gitignore`. Even
if you remove it in the workspace, or `git checkout` a different commit, the
if you remove it from the workspace, or `git checkout` a different commit, the
data is not lost if a corresponding DVC-file is committed. It's enough to run
`dvc checkout` or `dvc pull` to restore data files.

Expand Down Expand Up @@ -181,10 +181,10 @@ stages) we need to apply. This is important when you run `dvc repro` to
regenerate the final or intermediate result.

Second, hopefully it's clear by now that the actual data is stored in the
`.dvc/cache` directory, each file having a name in a form of an md5 hash. This
cache is similar to Git's
[objects database](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects) but
made specifically to handle large data files.
`.dvc/cache` directory, each file having a name based on an MD5 hash. This cache
is similar to Git's
[objects database](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects),
but made specifically to handle large data files.

> **Note!** For performance with large datasets, DVC can use file links from the
> cache to the workspace to avoid copying actual file contents. Refer to
Expand Down
2 changes: 1 addition & 1 deletion static/docs/get-started/example-versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ As we have learned already, DVC keeps data files out of Git (by adjusting
`.gitignore`) and puts them into the cache (usually it's a `.dvc/cache`
directory inside the repository). Instead, DVC creates
[DVC-files](/doc/user-guide/dvc-file-format). These text files serve as pointers
(`md5` hash) to the cache and are version controlled by Git.
(MD5 hash) to the cache and are version controlled by Git.

When we run `git checkout` we restore pointers (DVC-files) first, then when we
run `dvc checkout` we use these pointers to put the right data in the right
Expand Down
4 changes: 2 additions & 2 deletions static/docs/get-started/import-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ outs:
```

The `url` subfield points to the source project, while `rev_lock` lets DVC know
which Git version did the data come from. Note that `dvc update` updates the
`rev_lock` value.
which Git repository version did the data come from. Note that `dvc update`
updates the `rev_lock` value.

</details>

Expand Down
4 changes: 2 additions & 2 deletions static/docs/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ on [pipelines and reproducibility](/doc/get-started/example-pipeline).
✅ Please, join our [community](/chat) or see these [support](/support) options
if you have any questions or need any help. We are very responsive ⚡.

✅ Check out our [Github repository](https://github.com/iterative/dvc) and give
✅ Check out our [GitHub repository](https://github.com/iterative/dvc) and give
us a ⭐ if you like the project!

✅ Contribute either [on Github](https://github.com/iterative/dvc) or
✅ Contribute either [on GitHub](https://github.com/iterative/dvc) or
[on Patreon](https://www.patreon.com/DVCorg/overview) to support the project.

Separate to this section, the longer [Tutorial](/doc/tutorial) also introduces
Expand Down
4 changes: 2 additions & 2 deletions static/docs/get-started/reproduce.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ If you just cloned the
[project](https://github.com/iterative/example-get-started), make sure you first
fetch the input data from DVC by calling `dvc pull`.

It's now extremely easy for you or anyone in your team to reproduce the result
It's now extremely easy for you or your colleagues to reproduce the result
end-to-end:

```dvc
Expand All @@ -21,7 +21,7 @@ $ dvc repro train.dvc
> If you've just followed the previous chapters, the command above will have
> nothing to reproduce since you've recently executed all the pipeline stages.
> To easily try this command, clone this example
> [Github project](https://github.com/iterative/example-get-started) and run it
> [GitHub project](https://github.com/iterative/example-get-started) and run it
> from there.

`train.dvc` describes which source code and data files to use, and how to run
Expand Down
4 changes: 2 additions & 2 deletions static/docs/get-started/store-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ $ dvc push
```

The same way as with Git remote, it ensures that your data files and your models
are safely stored remotely and are shareable. It means that this data could be
pulled by your team or you when you need it.
are safely stored remotely and are shareable. This means that the data can be
pulled by yourself or your colleagues whenever you need it.

Usually, you run it along with `git commit` and `git push` to save the changed
[DVC-files](/doc/user-guide/dvc-file-format).
Expand Down
2 changes: 1 addition & 1 deletion static/docs/tutorial/define-ml-pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ need to run `dvc unprotect` or `dvc remove` first (see the
If you take a look at the [DVC-file](/doc/user-guide/dvc-file-format) created by
`dvc add`, you will see that <abbr>outputs</abbr> are tracked in the `outs`
field. In this file, only one output is specified. The output contains the data
file path in the repository and md5 checksum. This checksum determines a
file path in the repository and its MD5 checksum. This checksum determines a
location of the actual content file in the
[cache directory](/doc/user-guide/dvc-files-and-directories#structure-of-cache-directory),
`.dvc/cache`.
Expand Down
4 changes: 2 additions & 2 deletions static/docs/tutorial/reproducibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ master:
Let's keep the result in the repository. Later we can find out why bigrams don't
add value to the current model and change that.

Many DVC-files were changed. This happened due to md5 checksum changes.
Many DVC-files were changed. This happened due to MD5 checksum changes.

```dvc
$ git status -s
Expand Down Expand Up @@ -233,7 +233,7 @@ CONFLICT (content): Merge conflict in Dvcfile
Automatic merge failed; fix conflicts and then commit the result.
```

The merge has a few conflicts. All of the conflicts are related to md5 checksum
The merge has a few conflicts. All of the conflicts are related to MD5 checksum
mismatches in the branches. You can properly merge conflicts by prioritizing the
checksums from the bigrams branch: that is, by removing all checksums of the
other branch.
Expand Down
13 changes: 7 additions & 6 deletions static/docs/tutorial/sharing-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

## Pushing data to the cloud

It is pretty clear how code and DVC-files can be shared through Git
repositories. These repositories will contain all the information needed for
reproducibility and it might be a good idea to share these DVC-repositories
using GitHub or other Git services.
We've gone over how source code and [DVC-files](/doc/user-guide/dvc-file-format)
can be shared using a Git repository. These DVC repositories will contain all
the information needed for reproducibility, so it might be a good idea to share
them with your team using Git hosting services (such as
[GitHub](https://github.com/)).

DVC is able to push the <abbr>cache</abbr> to cloud storage.

Expand Down Expand Up @@ -47,8 +48,8 @@ pushed because the rest of the data files belong to different branches like

## Pulling data from the cloud

In order to reuse your data files, a colleague of yours can pull data the same
way from the master branch:
In order to reuse your data files, a colleague can pull data the same way from
the master branch:

```dvc
$ git clone https://github.com/dmpetrov/new_tag_classifier.git
Expand Down
4 changes: 2 additions & 2 deletions static/docs/understanding-dvc/core-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@
5. **Open-sourced** and **Self-served**: DVC is free and doesn't require any
additional services.

6. DVC supports cloud storage (Amazon S3, Azure Blob Storage and GCP storage)
for **data sources and pre-trained models sharing**.
6. DVC supports cloud storage (Amazon S3, Azure Blob Storage, and Google Cloud
Storage) for **data sources and pre-trained models sharing**.
6 changes: 3 additions & 3 deletions static/docs/understanding-dvc/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,14 @@
Rscript plot.R result.csv plots.jpg
```

7. The cache of a DVC project can be shared with your colleagues and partners
through Amazon S3, Azure Blob Storage GCP Storage, among others:
7. The cache of a DVC project can be shared with colleagues through Amazon S3,
Azure Blob Storage, Google Cloud Storage, among others:

```dvc
$ git push
$ dvc push # push from the cache to remote storage

# On a colleague machine:
# On a colleague's machine:
$ git clone https://github.com/dataversioncontrol/myrepo.git
$ cd myrepo
$ git pull # download tracked data from remote storage
Expand Down
2 changes: 1 addition & 1 deletion static/docs/understanding-dvc/related-technologies.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ process.

- `git-lfs` was not made with data science scenarios in mind, so it does not
provide related features (e.g. pipelines,
[metrics](/doc/command-reference/metrics)), and thus Github has a limit of 2
[metrics](/doc/command-reference/metrics)), and thus GitHub has a limit of 2
GB per repository.

---
Expand Down
Loading