README.md: Improve description of DVC use #5
Conversation
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 addresses the following complaint: > In addition, while I was able to set up the environment easily > thanks to the `init.bash` script provided, the script did not work > completely. It failed first because the README.md is not mentioning > that the script needs to be run inside a git project directory.
This addresses the following complaint: > The README.md is missing a description of the activities carried > out by each stage and a general overview of the pipeline > (You could've presented the DVC dag and a brief description > of each stage, for instance).
By reordering lines in the source of the simplified graph of DVC stage dependencies (in Mermaid format: https://mermaid.js.org/), there is less edge crossing, and the `dvc dag` diagram looks better.
This section describes such DVC pipeline stage requirements like Internet access, or having `git` installed, or a valid GitHub API key.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Jakub Narębski (4):
README.md: Mention Git repo requirement in "Running with DVC"
README.md: Add "Description of DVC stages" subsection
README.md: Improve the look of
dvc dagdiagramREADME.md: Add "Additional stages' requirements" subsection