Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

concepts: Describe "target" concept #2698

Closed
iesahin opened this issue Aug 6, 2021 · 6 comments
Closed

concepts: Describe "target" concept #2698

iesahin opened this issue Aug 6, 2021 · 6 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) ⌛ status: wait-response Waiting a response from the outside of the organization type: discussion Requires active participation to reach a conclusion.

Comments

@iesahin
Copy link
Contributor

iesahin commented Aug 6, 2021

It looks we are using "target" in a specific way while describing dvc repro, and pipeline related documents. It might a good to define the term in a concept page.

@shcheklein shcheklein added the type: discussion Requires active participation to reach a conclusion. label Aug 6, 2021
@shcheklein
Copy link
Member

@iesahin could you please clarify the concern please? some examples would help a lot I think. (I'm already biased and do not feel the problem, heh :) )

@shcheklein shcheklein added A: docs Area: user documentation (gatsby-theme-iterative) ⌛ status: wait-response Waiting a response from the outside of the organization labels Aug 6, 2021
@iesahin
Copy link
Contributor Author

iesahin commented Aug 7, 2021

While writing dvc exp run guide, I noticed that "target" may mean another thing in the context of the experiments: Metrics to reach. If the user starts from the pipelines and learns what we mean by targets, they'll have no problem. But if they are starting from scratch and we tell them about dvc exp run <target>, it may also mean "run until the experiment metrics reach a target." Especially within the checkpoints context, where we will discuss/implement this. (e.g. #2244, #2509)

I'm assuming the reader is skimming and lazy, BTW. :)

Explaining what we mean by target and using the word solely within pipelines context may be better.

@shcheklein
Copy link
Member

I would say that if we think that the word target in the context of dvc exp usually means a metric to achieve and we use actively nearby with its regular meaning (stage, file, etc), it's better then to use something else for the argument name dvc exp run <target> to avoid the confusion. Or use "goal" for the metric. I'm not sure how can the concept explanation help to be honest. Unless I'm missing something.

using the word solely within pipelines context may be better.

would this alone be enough?

@jorgeorpinel
Copy link
Contributor

we are using "target" in a specific way while describing dvc repro

At least in https://dvc.org/doc/command-reference/repro "targets" refers to the command's argument, specifically defined in the Options section.

I noticed that "target" may mean another thing in the context of the experiments: Metrics to reach

It's fine to use the word "target" in this context too. I don't think a tooltip will help if the worry is disambiguation. The text context should be clear enough. Alternatively you can use "goal" or some other similar term.

On the other hand basic concepts should be DVC-specific and "a metric to reach" relates in general to data science or even other fields, I think.

better then to use something else for the argument name dvc exp run to avoid the confusion

I honestly don't think this will be confusing (hasn't been so far that I know of). Also, renaming it here would imply renaming it in many other commands and it may not be easy to find another term that covers them all. But if it does end up being confusing we can bring this up again with the core team.

@jorgeorpinel jorgeorpinel added ⌛ status: wait-response Waiting a response from the outside of the organization and removed ⌛ status: wait-response Waiting a response from the outside of the organization labels Aug 12, 2021
@iesahin
Copy link
Contributor Author

iesahin commented Aug 14, 2021

OK, if you both see this as a non-problem, I'm closing this. Thank you for the comments. @jorgeorpinel @shcheklein

@iesahin iesahin closed this as completed Aug 14, 2021
@jorgeorpinel
Copy link
Contributor

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) ⌛ status: wait-response Waiting a response from the outside of the organization type: discussion Requires active participation to reach a conclusion.
Projects
None yet
Development

No branches or pull requests

3 participants