Dvc.org: user-guide: describe what run-cache is and what commands it affects

[efiop]

So far affected commands are run/repro with create and/or use run cache. And push/pull/fetch/potentially status) that transfer (options for that are hidden for now) run cache to/from remote. Run cache is located in.dvc/cache/runs`.

[efiop]

Will also need to update run-cache flags in run/repro to explain them through the run-cache concept.

[sarthakforwet]

Hey there I wanna work on this issue . Could you assign me this ?

[efiop]

Hi @sarthakforwet ! Thank you! But I don't think it is suitable for a contribution, as it is a WIP feature. Please check out need-help and good-first-issue labels, they should have something more suitable :slightly_smiling_face:

[jorgeorpinel]

Hi @sarthakforwet indeed please further explore the issues for something that seems a little smaller and more defined. I believe I sent some specific links in my GSoD email reply to you to some recommended issue labels. Feel free to reach out to me directly via email or on Discord for help on issue selection it you're still unsure. Thanks!

[jorgeorpinel]

A suggested place to start is to add an "execution and reproduction" section to the dvc run cmd ref. similar to this: https://github.com/iterative/dvc.org/pull/1464/files

[jorgeorpinel]

More info that would be good to include for this ticket, from https://github.com/iterative/dvc.org/pull/1448#discussion_r443124577:

1. Run-Cache can generate outputs in a suitable condition and that too indirectly (eg: only on run/repro), whereas a lockfile will always provide you with outputs without rerunning.
2. RunCache can generate lockfile. Even though you have a run-cache, you should still use lockfile because for the outputs.
3. get/import commands work well only if you have a lockfiile.

(Thanks @skshetry)

[jorgeorpinel]

Hello! So this continues to be a major discrepancy between released DVC and published docs. I know it's being worked on but at least basic mentions of this should exist in the docs for now. Is it still the plan for someone from engineering to submit a draft proposal adding such mentions? Thanks! Cc @efiop @shcheklein

[efiop]

@jorgeorpinel Likely no drafts until experiments are here or https://github.com/iterative/dvc/issues/4223 .