Skip to content

run-cache: basic docs#2137

Merged
jorgeorpinel merged 3 commits into
masterfrom
run-cache
Feb 4, 2021
Merged

run-cache: basic docs#2137
jorgeorpinel merged 3 commits into
masterfrom
run-cache

Conversation

@jorgeorpinel
Copy link
Copy Markdown
Contributor

@jorgeorpinel jorgeorpinel commented Feb 2, 2021

Closes #1289

  • New tooltip
  • Update internal files guide (cache structure section)
  • Link from --run-cache command options
    • correct repro --pull desc.

This is needed for/ related to #1926

@shcheklein shcheklein temporarily deployed to dvc-landing-run-cache-xuygpgdz February 2, 2021 04:41 Inactive
@jorgeorpinel jorgeorpinel mentioned this pull request Feb 2, 2021
12 tasks
Comment thread content/docs/command-reference/repro.md Outdated
Comment on lines 182 to 187
- `--pull` - [pulls](/doc/command-reference/pull) dependencies and outputs
involved in the stages being reproduced, if they are found in the
[default](/doc/command-reference/remote/default) remote storage. Note that it
checks the local run-cache too (available history of stage runs).
[default remote storage](/doc/command-reference/remote/default). Note that it
tries the local run-cache first.

> Has no effect if combined with `--no-run-cache`.
Copy link
Copy Markdown
Contributor Author

@jorgeorpinel jorgeorpinel Feb 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question @pmrowla or @efiop 👋 (I forget who contributed this part):

If deps/outs are found in the remote but there's no local cache AND the --no-run-cache option is used, does it download them from the remote or not? I suspect that part here isn't exactly accurate. Thanks

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will only be downloaded if --pull is specified.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right. But I meant if --pull is used WITH --no-run-cache, while there's no run-cache, --pull still does something? The way this is written now indicates that --no-run-cache somehow cancels all effects of --pull.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, --pull will still try to download using existing lockfiles, even if --no-run-cache is specified.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK then, corrected this a bit. Thanks

Comment thread content/docs/user-guide/basic-concepts/run-cache.md Outdated
Comment thread content/docs/user-guide/project-structure/internal-files.md
Comment on lines +128 to +132
### Run-cache

`dvc repro` and `dvc run` by default populate and reutilize a log of stages that
have been run in the project. It is found in the `runs/` directory inside the
cache (or [remote storage](/doc/command-reference/remote)).
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than in the DVC Internals guide should this be elsewhere?

If anyone can think of scenarios/examples/how-tos we should consider to mention the run-cache please lmk.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

E.g. do we still want a section in run (or repro) like this: https://github.com/iterative/dvc.org/pull/1464/files ?

@jorgeorpinel jorgeorpinel requested a review from efiop February 4, 2021 00:26
@jorgeorpinel jorgeorpinel merged commit b2149f1 into master Feb 4, 2021
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-run-cache-xuygpgdz February 4, 2021 01:30 Inactive
@jorgeorpinel jorgeorpinel deleted the run-cache branch February 7, 2021 03:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

guide: document run-cache

3 participants