Misc. updates (2.0ish) #2062

jorgeorpinel · 2020-12-28T02:24:29Z

Some copy edits loosely realated to the work in 2.0 Pipelines (parametrization) #2052
~~Review~~Reorg/rewrite of params cmd refs.

per #2052 (review)

from https://github.com/iterative/dvc.org/pull/2053/files#diff-584bff5a435baee84112ffda33bc2d9dc94e1512e7306322f43655d5e7593876 per #2062 (review)

per #2062 (review)

rel #2062 (review)

per #2062 (review)

per #2062 (review) and #2062 (review)

extracted to #2062

content/docs/command-reference/plots/index.md

content/docs/user-guide/dvc-files.md

per #2062 (review), #2062 (review), and #2062 (review)

shcheklein · 2021-01-03T21:07:41Z

content/docs/command-reference/metrics/diff.md

-  arguments for `--targets` before `revisions`, you should use `--` after this
-  option's arguments, e.g.:
+- `--targets <paths>` - specify the command's scope to these metrics files. It
+  accepts `paths` to any valid metrics file, regardless of whether it's used by


I think not used by DVC is not very clear, can we rephrase it somehow?

OK changed to "regardless of whether dvc.yaml is currently tracking any metrics in them". WDYT?

it's not even about dvc.yaml at this point, even DVC repo might not be initialized. I see that the whole change for that ticket might be out of scope since it's a much bigger change

You're right but yes, since iterative/dvc/issues/4446 is still open and the core team hasn't really sent many docs updates per their work on that... We could leave for later.

Then again since I just added that note about not needing a DVC project... This text in --targets is kind of contradicting again... ~~I'll simplify it a little for now (less specific).~~

UPDATE: Actually, I'm not sure how to generalize since we didn't want to say "not used by DVC". Sry

p.s. the current text is not incorrect so... I think it should do for now 🙂

content/docs/command-reference/plots/diff.md

to match iterative/dvc.org/pull/2062

content/docs/command-reference/diff.md

shcheklein · 2021-01-04T03:10:11Z

content/docs/command-reference/params/diff.md

-
-❗ By default it only shows parameters that were changed.
+This includes everything in `params.yaml` (default parameters file) as well
+everything listed in the `params` field of `dvc.yaml`/`dvc.lock`. Only params


still don't understand what does as well everything listed in the paramsfield ofdvc.yaml/dvc.lock`` mean

params diff withuot arguments shows everything changed in params.yaml as well as all params defined in dvc.yaml. And soon also even params used to templetize dvc.yaml (but that's not in scope, more for #2052).

I simplified to "...as well all the params used in dvc.yaml." and separated the mention of dvc.lock into a following sentence.

shcheklein · 2021-01-04T03:14:05Z

content/docs/command-reference/params/index.md

+stages:
+  preprocess:
+    cmd: ./prepare.py
+    params:


we use epochs, learning-rate, batch_siz above, let's do the same in the example?

Yes, that is way better 😅. Done!

shcheklein · 2021-01-04T03:15:01Z

content/docs/command-reference/params/index.md

-DVC saves the param names and their latest values in the `dvc.yaml` file. These
-values will be compared to the ones in the params files to determine if the
-stage is invalidated upon pipeline [reproduction](/doc/command-reference/repro).
+In contrast to a regular <abbr>dependency</abbr>, a parameter is not a file or


a parameter dependency ...

shcheklein · 2021-01-04T03:19:06Z

content/docs/command-reference/params/index.md

+specific meaning to these values.
+
+DVC saves parameter names and values in the project's
+[DVC files](/doc/user-guide/dvc-files) in order to track them over time. They


in this case we can be specific? dvc.lock?

Agree. Specified.

shcheklein

Some minor things left. I suggest to address the whole story related to non DVC repos for metrics/plots/etc separately. It's a bigger problem that we can handle for Misc updates.

to match iterative/dvc.org/pull/2062

jorgeorpinel · 2021-01-05T06:02:02Z

address the whole story related to non DVC repos for metrics/plots/etc separately

Agree. I'm hoping to do so as docs changes from core PRs related to iterative/dvc/issues/4446 continue to arrive.

Merging!

jorgeorpinel added 20 commits December 21, 2020 10:51

Merge branch 'master' into jorge

1cf6519

config: standardize sample variable/option values

8dd77a9

Merge branch 'master' into jorge

df113ec

cmd: misc updates to repro, gc, run

4dd5322

Merge branch 'jorge' of github.com:iterative/dvc.org into jorge

fa30e85

Merge branch 'master' into jorge

27b3007

Merge branch 'jorge' of github.com:iterative/dvc.org into jorge

2e370de

Merge branch 'master' into jorge

ec5cb83

blog: manually format a md string in frontmatter

e7297b5

guide: multi cmd in main dvc.yaml example

523af6b

per #2052 (review)

guide: copy edit in dvc.yaml

442d325

per #2052 (review)

cmd: remove term "self-incrementing"

3e5435a

guide: re-instate deleted changes

95965ea

from https://github.com/iterative/dvc.org/pull/2053/files#diff-584bff5a435baee84112ffda33bc2d9dc94e1512e7306322f43655d5e7593876 per #2062 (review)

cmd: review params refs

7a59869

blog: fix broken frontmatter

a7f35ef

per #2062 (review)

cmd: update params def. explanation in diff like it is in index

194e1e4

rel #2062 (review)

cmd: absorb a params diff note into a p

4e1cb47

per #2062 (review)

cmd: more improvements and reord to params docs

8ede12f

per #2062 (review) and #2062 (review)

guide: expand on dvc.yaml params field (multiple params files)

0930fa4

guide: remove emoji we never use from recs

bf0f04c

shcheklein temporarily deployed to dvc-landing-jorge-3ob4u99krie7 December 28, 2020 02:24 Inactive

shcheklein had a problem deploying to dvc-landing-jorge-4fnatpd3dlzo December 28, 2020 02:32 Failure

jorgeorpinel mentioned this pull request Dec 28, 2020

2.0 Pipelines (parametrization) #2052

Merged

8 tasks

jorgeorpinel temporarily deployed to dvc-landing-jorge-4fnatpd3dlzo December 28, 2020 02:36 Inactive

jorgeorpinel added a commit that referenced this pull request Dec 28, 2020

guide: roll back out-of-scope copy edits

5e06e2f

extracted to #2062

shcheklein temporarily deployed to dvc-landing-jorge-eqcazokpzjdf December 28, 2020 03:07 Inactive

jorgeorpinel commented Dec 28, 2020

View reviewed changes

content/docs/command-reference/plots/index.md Show resolved Hide resolved

jorgeorpinel marked this pull request as ready for review December 28, 2020 03:09

jorgeorpinel changed the title ~~Misc. updates (2.0)~~ Misc. updates (2.0ish) Dec 28, 2020

jorgeorpinel commented Dec 28, 2020

View reviewed changes

content/docs/user-guide/dvc-files.md Show resolved Hide resolved

cmd: final details on params index

3e7d40f

per #2062 (review), #2062 (review), and #2062 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorge-y9v9tpgve3zw January 3, 2021 20:33 Inactive

jorgeorpinel temporarily deployed to dvc-landing-jorge-y9v9tpgve3zw January 3, 2021 20:50 Inactive

jorgeorpinel temporarily deployed to dvc-landing-jorge-y9v9tpgve3zw January 3, 2021 20:54 Inactive

jorgeorpinel temporarily deployed to dvc-landing-jorge-y9v9tpgve3zw January 3, 2021 21:07 Inactive

shcheklein reviewed Jan 3, 2021

View reviewed changes

jorgeorpinel commented Jan 3, 2021

View reviewed changes

content/docs/command-reference/plots/diff.md Show resolved Hide resolved

jorgeorpinel mentioned this pull request Jan 3, 2021

guide: multi-cmd example in a dvc.yaml sample #2070

Closed

jorgeorpinel temporarily deployed to dvc-landing-jorge-y9v9tpgve3zw January 3, 2021 23:51 Inactive

jorgeorpinel temporarily deployed to dvc-landing-jorge-y9v9tpgve3zw January 4, 2021 00:04 Inactive

jorgeorpinel temporarily deployed to dvc-landing-jorge-y9v9tpgve3zw January 4, 2021 00:10 Inactive

jorgeorpinel requested a review from shcheklein January 4, 2021 00:14

jorgeorpinel temporarily deployed to dvc-landing-jorge-y9v9tpgve3zw January 4, 2021 00:14 Inactive

jorgeorpinel added a commit to iterative/dvc that referenced this pull request Jan 4, 2021

dvc: std/update --tragets options

e40d88d

to match iterative/dvc.org/pull/2062

jorgeorpinel mentioned this pull request Jan 4, 2021

dvc: std/update --targets options iterative/dvc#5193

Merged

2 tasks

jorgeorpinel temporarily deployed to dvc-landing-jorge-y9v9tpgve3zw January 4, 2021 00:33 Inactive

jorgeorpinel commented Jan 4, 2021

View reviewed changes

content/docs/command-reference/diff.md Show resolved Hide resolved

shcheklein reviewed Jan 4, 2021

View reviewed changes

shcheklein approved these changes Jan 4, 2021

View reviewed changes

efiop pushed a commit to iterative/dvc that referenced this pull request Jan 4, 2021

dvc: std/update --tragets options (#5193)

19606ba

to match iterative/dvc.org/pull/2062

jorgeorpinel temporarily deployed to dvc-landing-jorge-y9v9tpgve3zw January 5, 2021 05:16 Inactive

jorgeorpinel temporarily deployed to dvc-landing-jorge-y9v9tpgve3zw January 5, 2021 05:27 Inactive

jorgeorpinel deployed to dvc-landing-jorge-y9v9tpgve3zw January 5, 2021 05:47 View deployment

jorgeorpinel temporarily deployed to dvc-landing-jorge-y9v9tpgve3zw January 5, 2021 06:01 Inactive

jorgeorpinel merged commit e7a4f10 into master Jan 5, 2021

jorgeorpinel mentioned this pull request Jan 5, 2021

guide: remove confusing language around DVC File defaults #2072

Merged

Misc. updates (2.0ish) #2062

Misc. updates (2.0ish) #2062

Uh oh!

Conversation

jorgeorpinel commented Dec 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jorgeorpinel Jan 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jorgeorpinel Jan 5, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shcheklein left a comment

Choose a reason for hiding this comment

Uh oh!

jorgeorpinel commented Jan 5, 2021

Uh oh!

Uh oh!

jorgeorpinel commented Dec 28, 2020 •

edited

Loading

jorgeorpinel Jan 4, 2021 •

edited

Loading

jorgeorpinel Jan 5, 2021 •

edited

Loading