Skip to content

Commit

Permalink
Merge branch 'master' into guide/exps
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeorpinel committed Aug 11, 2021
2 parents 8d93521 + c983f7f commit 90f3042
Show file tree
Hide file tree
Showing 42 changed files with 793 additions and 403 deletions.
66 changes: 25 additions & 41 deletions content/community.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,60 +71,44 @@
],
"events": [
{
"url": "https://hasgeek.com/fifthelephant/mlops-conference/schedule",
"title": "HasGeek",
"description": "Milecia McGregor presents at HasGeek Conference from Fifth Elephant on Tuning Hyperparameters with DVC Experiments",
"city": "Virtual, Miami, FL",
"date": "2021-07-23",
"pictureUrl": "/img/community/events/hasgeek.png"
},
{
"url": "https://www.datasciencego.com/virtual",
"title": "Jervis Hui presents Top 3 Requirements for Effective MLOps",
"description": "On day two of this three day Conference, Jervis Hui presents on must haves for effective productionalization of Data Science Projects",
"url": "https://www.meetup.com/DVC-Community-Virtual-Meetups/events/279446210/",
"title": "DVC Learn Meetup - Sharing Experiments",
"description": "At this third session of DVC Learn, you will learn how to set up remote storage and share experiments with team members.",
"city": "Virtual",
"date": "2021-07-24",
"pictureUrl": "/img/community/events/dsgo.png"
"date": "2021-08-18",
"pictureUrl": "/img/community/events/dvc_learn.png"
},
{
"url": "https://www.meetup.com/DVC-Community-Virtual-Meetups/events/279024694/?isFirstPublish=true",
"title": "DVC July Office Hours Meetup",
"description": "For our R loving community members, João Santiago introduces 'dvcru' and DVC Studio demo, discussion and feedback",
"url": "https://www.meetup.com/DVC-Community-Virtual-Meetups/events/279723437/",
"title": "DVC August Office Hours Meetup",
"description": "At this month's Office Hours, Community member, Antoine Toubhans, presents DVC + Streamlit = ♥",
"city": "Virtual",
"date": "2021-07-28",
"date": "2021-08-19",
"pictureUrl": "/img/community/events/office-hours-meetup.png"
},
{
"url": "https://www.conf42.com/Machine_Learning_2021_Milecia_McGregor_Convolutional_Neural_Networks",
"title": "Conference 42: Machine Learning 2021",
"description": "Milecia McGregor will present Convolutional Neural Networks in Action",
"url": "https://www.musiccitytech.com/",
"title": "Music City Tech Conference",
"description": "Milecia McGregor presents Tuning Hyperparameters in Reproducible Experiments using grid search and random search with DVC.",
"city": "Virtual",
"date": "2021-07-29",
"pictureUrl": "/img/community/events/conf42.png"
"date": "2021-09-15",
"pictureUrl": "/img/community/events/music_city_tech.png"
},
{
"url": "https://www.meetup.com/DVC-Community-Virtual-Meetups/events/279447414/",
"title": "DVC Learn - Getting Started: Experiments",
"description": "Milecia McGregor will continue the next class of DVC Learn on setting up experiments",
"url": "https://www.dataconla.com/",
"title": "DataCon LA Conference",
"description": "Milecia McGregor presents Tuning Hyperparameters in Reproducible Experiments using grid search and random search with DVC.",
"city": "Virtual",
"date": "2021-08-04",
"pictureUrl": "/img/community/events/dvc_learn.png"
"date": "2021-09-17",
"pictureUrl": "/img/community/events/datacon_la.png"
},
{
"url": "https://www.igniteinnovationfl.com/",
"title": "Ignite Innovation Developer Conference",
"description": "Milecia McGregor will present on Using Reproducible Experiments To Create Better Machine Learning Models",
"city": "Virtual",
"date": "2021-08-06",
"pictureUrl": "/img/community/events/ignite-innovation.png"
},
{
"url": "https://www.meetup.com/DVC-Community-Virtual-Meetups/events/279446210/",
"title": "DVC Learn - Getting Started: Metrics",
"description": "Milecia McGregor will continue the next class of DVC Learn on how to check metrics",
"city": "Virtual",
"date": "2021-08-18",
"pictureUrl": "/img/community/events/dvc_learn.png"
"url": "https://devopsdays.org/events/2021-houston/welcome/",
"title": "DevOps Days Houston",
"description": "Milecia McGregor presents on Tuning Hyperparameters in Reproducible Experiments using grid search and random search with DVC.",
"city": "Live",
"date": "2021-09-21",
"pictureUrl": "/img/community/events/devops_days_Houston.png"
}
],
"stats": {
Expand Down
2 changes: 1 addition & 1 deletion content/docs/api-reference/read.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ These are loaded to memory directly (without using any disc space).
the target data. _Default_: The
[default remote](/doc/command-reference/remote/default) of `repo` is used if a
`remote` argument is not given. For local projects, the <abbr>cache</abbr> is
tied before the default remote.
tried before the default remote.

- `mode` - specifies the mode in which the file is opened. Defaults to `"r"`
(read). Mirrors the namesake parameter in builtin
Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/dag.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ $ DVC_PAGER=more dvc dag
For a persistent change, define `DVC_PAGER` in the shell configuration. For
example in Bash, we could add the following line to `~/.bashrc`:

```bash
export DVC_PAGER=more
```dvc
$ export DVC_PAGER=more
```

## Options
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ descriptions, and comprehensive usage examples for `dvc` commands. For a list of
commands, type `dvc -h`.

💡 To execute any DVC command in a different directory, use
`dvc --cd <path> ...` before the actual command and it's options/arguments (this
`dvc --cd <path> ...` before the actual command and its options/arguments (this
does not change directories in your terminal).

## Typical DVC workflow
Expand Down
5 changes: 2 additions & 3 deletions content/docs/command-reference/plots/diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,8 @@ all the current plots, without comparisons.

- `--title <text>` - plot title.

- `--show-vega` - produce a
[Vega specification](https://vega.github.io/vega/docs/specification/) file
instead of HTML. See `dvc plots` for more info.
- `--show-vega` - produce a [Vega-Lite](https://vega.github.io/vega-lite/) spec
file instead of HTML. See `dvc plots` for more info.

- `--open` - opens the generated plot in the browser automatically.

Expand Down
25 changes: 12 additions & 13 deletions content/docs/command-reference/plots/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ processing code, and can be defined in `dvc.yaml` (`plots` field) for tracking
(optional).

DVC generates plots as HTML files that can be open with a web browser. These
HTML files use [Vega-Lite](https://vega.github.io/vega-lite/). Vega is a
HTML files use [Vega-Lite](https://vega.github.io/vega-lite/). Vega-Lite is a
declarative grammar for defining plots using JSON. The plots can also be saved
as SVG or PNG image filed from the browser.

Expand Down Expand Up @@ -91,10 +91,10 @@ names in the `train` array below:
## Plot templates

Users have the ability to change the way plots are displayed by modifying the
[Vega specification](https://vega.github.io/vega/docs/specification/), thus
generating plots in the style that best fits the their needs. This keeps
<abbr>DVC projects</abbr> programming language agnostic, as it's independent
from user display configuration and visualization code.
[Vega-Lite specification](https://vega.github.io/vega-lite/), thus generating
plots in the style that best fits the their needs. This keeps <abbr>DVC
projects</abbr> programming language agnostic, as it's independent from user
display configuration and visualization code.

Built-in _plot templates_ are stored in the `.dvc/plots/` directory. The default
one is called `default.json`. It can be changed with the `--template` (`-t`)
Expand All @@ -113,11 +113,10 @@ DVC has the following built-in plot templates:

### Custom templates

Plot template files are
[Vega specification](https://vega.github.io/vega/docs/specification/) files that
use predefined DVC anchors as placeholders for DVC to inject the plot values.
You can create a custom template from scratch, or modify an existing one from
`.dvc/plots/`.
Plot template files are [Vega-Lite](https://vega.github.io/vega-lite/) files
that use predefined DVC anchors as placeholders for DVC to inject the plot
values. You can create a custom template from scratch, or modify an existing one
from `.dvc/plots/`.

💡 Note that custom templates can be safely added to the template directory.

Expand Down Expand Up @@ -165,7 +164,7 @@ using the the `--html-template` option. This allows you to customize the
container where DVC will inject plots it generates.

> ⚠️ This is a separate feature from
> [custom Vega templates](/doc/command-reference/plots#custom-templates).
> [custom Vega-Lite templates](/doc/command-reference/plots#custom-templates).
The only requirement for this HTML file is to specify the place to inject plots
with a `{plot_divs}` marker. See an
Expand Down Expand Up @@ -277,13 +276,13 @@ file:///Users/usr/src/plots/classes.csv.html
### Example: Offline HTML Template

The plots generated by `dvc plots` uses Vega JavaScript libraries, and by
The plots generated by `dvc plots` uses Vega-Lite JavaScript libraries, and by
default these load [online resources](https://vega.github.io/vega/usage/#embed).
There may be times when you need to produce plots without Internet access, or
want to customize the plots output to put some extra content, like banners or
extra text. DVC allows to replace the HTML file that contains the final plots.

Download the Vega libraries into the directory where you'll produce the
Download the Vega-Lite libraries into the directory where you'll produce the
`dvc plots`:

```dvc
Expand Down
4 changes: 2 additions & 2 deletions content/docs/command-reference/plots/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ The path to the metrics file `target` is required. It must be listed in a
the display properties to `dvc.yaml`.

Property names are passed as [options](#options) to this command (prefixed with
`--`). These are based on the full
[Vega specification](https://vega.github.io/vega/docs/specification/).
`--`). These are based on the [Vega-Lite](https://vega.github.io/vega-lite/)
specification.

Note that a secondary use of this command is to convert output or simple
`dvc metrics` file into a plots file (see an
Expand Down
16 changes: 7 additions & 9 deletions content/docs/command-reference/plots/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,8 @@ please see `dvc plots`.

- `--title <text>` - plot title.

- `--show-vega` - produce a
[Vega specification](https://vega.github.io/vega/docs/specification/) file
instead of HTML. See `dvc plots` for more info.
- `--show-vega` - produce a [Vega-Lite](https://vega.github.io/vega-lite/) spec
file instead of HTML. See `dvc plots` for more info.

- `--open` - opens the generated plot in the browser automatically.

Expand Down Expand Up @@ -203,14 +202,13 @@ $ dvc plots show --no-header logs.csv -y 2
file:///Users/usr/src/plots/logs.csv.html
```

## Example: Vega specification file
## Example: Vega-Lite specification file

In many automation scenarios (like CI/CD for ML), it is convenient to output the
[Vega specification](https://vega.github.io/vega/docs/specification/) file
instead of rendering an HTML plot. For example, to generating another image
format like PNG or JPEG, or to include it differently into a web/mobile app. The
`--show-vega` option prevents wrapping this plot spec in HTML. Note that the
resulting file is JSON:
[Vega-Lite](https://vega.github.io/vega-lite/) spec file instead of rendering an
HTML plot. For example, to generating another image format like PNG or JPEG, or
to include it differently into a web/mobile app. The `--show-vega` option
prevents wrapping this plot spec in HTML. Note that the resulting file is JSON:

```dvc
$ dvc plots show --show-vega logs.csv -y accuracy
Expand Down
10 changes: 5 additions & 5 deletions content/docs/command-reference/remote/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ Authentication example:
$ dvc remote add -d myremote s3://mybucket/path
$ export AWS_ACCESS_KEY_ID='mykey'
$ export AWS_SECRET_ACCESS_KEY='mysecret'
$ dvc remote push
$ dvc push
```

For more on the supported env vars, please see the
Expand Down Expand Up @@ -1087,7 +1087,7 @@ Using a default identity (e.g. credentials set by `az cli`):
```dvc
$ dvc remote add -d myremote azure://mycontainer/object
$ dvc remote modify myremote account_name 'myaccount'
$ dvc remote push
$ dvc push
```

> Note that this may require the `Storage Blob Data Contributor` and other roles
Expand All @@ -1098,7 +1098,7 @@ Using a `connection_string`:
```dvc
$ dvc remote add -d myremote azure://mycontainer/object
$ dvc remote modify --local myremote connection_string 'mysecret'
$ dvc remote push
$ dvc push
```

Using `account_key`:
Expand All @@ -1107,7 +1107,7 @@ Using `account_key`:
$ dvc remote add -d myremote azure://mycontainer/object
$ dvc remote modify --local myremote account_name 'myaccount'
$ dvc remote modify --local myremote account_key 'mysecret'
$ dvc remote push
$ dvc push
```

Using `sas_token`:
Expand All @@ -1116,5 +1116,5 @@ Using `sas_token`:
$ dvc remote add -d myremote azure://mycontainer/object
$ dvc remote modify --local myremote account_name 'myaccount'
$ dvc remote modify --local myremote sas_token 'mysecret'
$ dvc remote push
$ dvc push
```
5 changes: 3 additions & 2 deletions content/docs/command-reference/stage/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,8 +250,9 @@ data science experiments.
affect any DVC operations.

- `--live <path>` - specify the directory `path` for
[DVCLive](/doc/dvclive/dvclive-with-dvc) to write logs in. `path` will be
tracked (<abbr>cached</abbr>) by DVC. Saved in the `live` field of `dvc.yaml`.
[DVCLive](/doc/dvclive/user-guide/dvclive-with-dvc) to write logs in. `path`
will be tracked (<abbr>cached</abbr>) by DVC. Saved in the `live` field of
`dvc.yaml`.

- `--live-no-cache <path>` - the same as `--live` except that the `path` is not
tracked by DVC. Useful if you prefer to track it with Git.
Expand Down
2 changes: 0 additions & 2 deletions content/docs/dvclive/api-reference/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,5 @@ all existing `.tsv` files, `{path}.json` and `{path.html}`.

- `dvclive.error.DvcLiveError` - If the directory `path` can't be created.

...

[`dvclive.log()`]: /doc/dvclive/api-reference/log
[`dvclive.next_step()`]: /doc/dvclive/api-reference/next_step
2 changes: 0 additions & 2 deletions content/docs/dvclive/api-reference/log.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,4 @@ environment variables (when used alongside `DVC`).

- `dvclive.error.DvcLiveError` - If the provided `val` has not supported type.

...

[`dvclive.init()`]: /doc/dvclive/api-reference/init
2 changes: 0 additions & 2 deletions content/docs/dvclive/api-reference/next_step.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,5 @@ prepare an HTML report with all the _metrics logs_ logged in `path`.
- `dvclive.error.InitializationError` - If `dvclive` has not been properly
initialized (i.e. by calling [`dvclive.init()`] or [`dvclive.log()`]).

...

[`dvclive.init()`]: /doc/dvclive/api-reference/init
[`dvclive.log()`]: /doc/dvclive/api-reference/log
Loading

0 comments on commit 90f3042

Please sign in to comment.