Dvc.org: user-guide: add "folders" way of experimentation

Created on 19 Jan 2019  路  12Comments  路  Source: iterative/dvc.org

Currently, we only mention branches as a way of experimentation (in Get Started), but it is not ideal and we've seen users use folders as an alternative. Need to mention it in our docs.

doc-content enhancement

Most helpful comment

I think we should keep a single way in get started, mention other ways in user-guide and make a link to it. I'm switching get started to use tags now to avoid merging and other complicated ugly stuff.

All 12 comments

I think we should keep a single way in get started, mention other ways in user-guide and make a link to it. I'm switching get started to use tags now to avoid merging and other complicated ugly stuff.

馃憤 @dashohoxha it can be a more general Managing Experiments use case or user guide section. It can include different approaches - folders, tags, branches, commits, etc.

The last step of this lesson mentions something about using different folders for different pipelines:
https://katacoda.com/dvc/courses/basics/pipelines
But I am not sure if this is enough to close this issue.

@dashohoxha Feels like it would be suitable to describe that more formally, hence why I was mentioning "user guide" and not "get-started" or "tutorial".

@efiop Right. But some things are better explained with a working example. It may also be easier for the users to understand it. And an example can also be complemented by formal and generalized descriptions.

general Managing Experiments use case or user guide section. It can include different approaches - folders, tags, branches, commits, etc.

I reviewed all docs and he term "experiment" is not mentioned in the User Guide at all, and only once in Use Cases (in Shared Development Server). Otherwise we mainly talk about experiments in command references and tutorials. So it seems this new Managing Experiments is still a valid enhancement. Please note we should use the term "directory" instead of "folder" though.

So it seems this new Managing Experiments is still a valid enhancement.

@jorgeorpinel are you working on it?
I am asking so that we don't make a conflict with #816.

I'm not. I was just reviewing the validity of some older issues.
But if #816 addresses this, maybe one of the 2 should be closed?

But if #816 addresses this, maybe one of the 2 should be closed?

I think that they overlap but are not quite the same. We can close them both with this PR: https://github.com/iterative/dvc.org/pull/828

Closing in favor of #816

Was this page helpful?
0 / 5 - 0 ratings