-
Notifications
You must be signed in to change notification settings - Fork 394
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
Parameters: separate info among docs sections #3899
Merged
Merged
Changes from all commits
Commits
Show all changes
105 commits
Select commit
Hold shift + click to select a range
f91f015
initial plan and some content
fd20226
added content about stages
b279db7
title and restyle fixes
iesahin 881f3af
added dag section
iesahin 0e95212
depend to -> depend on
iesahin 78f342d
added dependencies section
iesahin b2a949d
Update content/docs/user-guide/pipelines/index.md
jorgeorpinel 9d5ee22
Update content/docs/user-guide/pipelines/index.md
jorgeorpinel 678753d
Restyled by prettier (#3532)
restyled-io[bot] 7fe19e7
Update content/docs/user-guide/pipelines/index.md
iesahin e932c8d
added pipelines to sidebar
iesahin baf6ce1
updated the title
iesahin caf3291
fixed formatting
iesahin 2e98221
updating for dvc.yaml first
iesahin 15ba67f
fed -> used
iesahin d749c2a
dvc.yaml-first
iesahin f01e750
editing to tell dvc.yaml first
iesahin 78cfebd
minor fix
iesahin 9989902
url dependency
iesahin f51bfd5
dvc lock example
iesahin 5edc29b
section titles for deps
iesahin 9649c0f
section titles for outputs
iesahin bb7c0a1
reproduction -> running
iesahin e26734e
adding hyperparameters section
iesahin 424a196
added experiments section
iesahin e43bc98
adding url dependencies
iesahin ee7703c
added outputs section content
iesahin 602e327
minor
iesahin 1b08b42
added running pipelines content
iesahin 1ff0479
moved outputs below running
iesahin 27ef04f
removed plots section header
iesahin c2c0461
Merge branch 'main' into iesahin/ug-pipelines
jorgeorpinel 7df801a
guide: Defining Data Pipelines
jorgeorpinel 605a000
guide: split up Data Pipelines section
jorgeorpinel f22f2a0
Update content/docs/command-reference/plots/templates.md
jorgeorpinel 928ad25
Merge branch 'main' into iesahin/ug-pipelines
jorgeorpinel 73982c2
guide: Data Pipes -> ML Pipes
jorgeorpinel a97006e
guide: oops, remove op-pipes file
jorgeorpinel f9f0a59
guide: remoge ML Pipes intro
jorgeorpinel 53b4321
guide: mention both imports in Def ML Pipes
jorgeorpinel b6d8a0c
guide: move DAG info from cmd ref
jorgeorpinel 60af6a7
guide: move all info and links about DAG to ML Pipes
jorgeorpinel 830fe2b
guide: point from some Stage links to ML Pipes
jorgeorpinel cb042af
guide: delete Running ML Pipes (for now)
jorgeorpinel b8844da
nav: remove future ML Pipes guides
jorgeorpinel 2040246
guide: remove ML Pipes/ Experimental Pipes
jorgeorpinel 192e189
roll back unrelated changes...
jorgeorpinel 078b50d
guide: roll back dvc.yaml page changes
jorgeorpinel fed4832
guide: link ML Pipes/ Defining Stages to dvc.yaml/stages spec
jorgeorpinel 49780b6
Merge branch 'main' into iesahin/ug-pipelines
jorgeorpinel 3410b6a
guide: link deps and params tooltip to ML Pipes/ Stages guide sections
jorgeorpinel 0ca32c2
guide: links from dvc.yaml doc to ML Pipes/ Stages
jorgeorpinel 8a55302
guide: more links
jorgeorpinel 7ebc3ad
guide: oops, remove unused files
jorgeorpinel 7461b07
remove unrelated change
jorgeorpinel bea5368
guide: move stage definition details to ML Pipes
jorgeorpinel e44433c
guide: move stage command details into ML Pipes
jorgeorpinel e47d741
Merge branch 'main' into iesahin/ug-pipelines
jorgeorpinel a4824a1
Merge branch 'main' into iesahin/ug-pipelines
jorgeorpinel 1411ec7
ref: roll back unrelated changes
jorgeorpinel 9800a35
.
jorgeorpinel 43517c4
ref: few more links to dependency graph in guide
jorgeorpinel 0b81e74
Merge branch 'main' into iesahin/ug-pipelines
jorgeorpinel 09f5aaf
ref: reorg exp init to include simple usage example in Desc
jorgeorpinel ded42ff
concept: reintroduce DAG in more places
jorgeorpinel 8ebd1bb
guide: pipelines are not ML-specific
jorgeorpinel 55afd17
guide: more details for params fields
jorgeorpinel 076402f
one word
jorgeorpinel e065653
Merge branch 'main' into iesahin/ug-pipelines
jorgeorpinel adc4382
guide: restructure Def Pipes and
jorgeorpinel 3f8e29a
guide: rewrite Def Pipes intro
jorgeorpinel 4f3391a
guide: move DAG up in Def Pipes
jorgeorpinel 86e5b18
guide: inner link in Def Pipes
jorgeorpinel 8e88b7f
guide: fix link and typos
jorgeorpinel 9216380
start: revert DAG changes
jorgeorpinel 51151c8
guide: use typical ML stage names
jorgeorpinel 50b2513
guide: better flow in Pipes index
jorgeorpinel 29790fd
glossary: high-level def of Pipes
jorgeorpinel dc3b6bc
guide: move Stage command to dvc.yaml ref
jorgeorpinel dadd099
guide: remove abc mention
jorgeorpinel 0283efc
guide: edits to Defining Pipes
jorgeorpinel b55ac41
guide: improve Param deps in Def Pipes and
jorgeorpinel b947c67
guide: add Outputs to Def Pipes
jorgeorpinel bfe0ec2
Merge branch 'main' into iesahin/ug-pipelines
jorgeorpinel 8505bc7
guide: update dep, param and out tooltips
jorgeorpinel 57ed5c0
Merge branch 'main' into iesahin/ug-pipelines
jorgeorpinel 627afb5
guide: separate params in Pipes vs Exps
jorgeorpinel 502b3bd
ref: move Stage commands section of dvc.yaml up
jorgeorpinel 533a1b0
guide: update Def Pipes and DAG
jorgeorpinel c5cbf58
params: more separation of content and
jorgeorpinel 416d312
concept: rehash params
jorgeorpinel 75340be
guide: more holistic pipelining info
jorgeorpinel dc16807
guide: Pipe edits
jorgeorpinel 23cd9c6
params: roll back changes for now...
jorgeorpinel 72bd5ee
Revert "params: roll back changes for now..."
jorgeorpinel 3c8f635
Merge branch 'main' into iesahin/ug-pipelines
jorgeorpinel ef24051
guide: more edits to Pipelines
jorgeorpinel a542867
Merge branch 'main' into iesahin/ug-pipelines
jorgeorpinel a316948
Merge branch 'main' into params/refactor
jorgeorpinel b5a2d9f
params: do not define as "simple values"
jorgeorpinel 80cb220
Merge branch 'iesahin/ug-pipelines' into params/refactor
jorgeorpinel 4a590f8
ref: better params index intro
jorgeorpinel 11ed801
ref: mention param groups in dvc.yaml
jorgeorpinel 4005a8a
params: DVC can pass them via templating/dict unpacking
jorgeorpinel 6bf10e7
Merge branch 'main' into params/refactor
jorgeorpinel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,10 @@ | ||
--- | ||
name: 'Parameter Dependency' | ||
match: [parameter, parameters, param, params, hyperparameter, hyperparameters] | ||
name: 'Parameters' | ||
match: [parameter, parameters] | ||
tooltip: >- | ||
Pipeline stages (defined in `dvc.yaml`) can depend on specific values inside | ||
an arbitrary YAML, JSON, TOML, or Python file (`params.yaml` by default). | ||
Stages are invalid (considered outdated) when any of their parameter values | ||
change. See [`dvc params`](/doc/command-reference/params). | ||
Hyperparameters or other config values used by your code, loaded from a a | ||
structured file (`params.yaml` by default). They can be tracked as granular | ||
dependencies for stages of DVC pipelines (defined in `dvc.yaml`). DVC can also | ||
compare them among machine learning experiments (useful for optimization). See | ||
`dvc params`. | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
previous was better I think
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to roll back. The idea here is that the cmd ref should be self-contained so linking between references when possible makes sense. Alternatively we could use the tooltip instead of link.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Feel free to commit: