-
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
guide: absorb What is DVC? into other existing docs, et al. #1581
Merged
+213
−314
Merged
Changes from 1 commit
Commits
Show all changes
44 commits
Select commit
Hold shift + click to select a range
6690907
guide: What is DVC? -> into UG index
jorgeorpinel ce72b11
how-to: create section with questions from WID / Collab Issues
jorgeorpinel b466986
Merge branch 'master' into guide/what-is-dvc
jorgeorpinel 3f0b0f0
how-to: make subsection of the user-guide, and
jorgeorpinel 5a5901b
guide: hide Best Practices how to for now
jorgeorpinel a94d9f8
guide: rename how to and best practices title
jorgeorpinel 92ae254
guide: What->Why in index to avoid redundancy with What section
jorgeorpinel d7762e6
guide: concepts->principles in What is DVC?
jorgeorpinel 82554fe
guide: move troubleshooting inside How To
jorgeorpinel 05a7a7d
guide: collapse What is DVC? into single doc, and
jorgeorpinel 3e46fca
guide: fix redirect test for troubleshooting how to
jorgeorpinel 93cc607
guide: revise What is DVC? up to Core Principles and
jorgeorpinel 8a7c086
guide: finish revising What is DVC?
jorgeorpinel c30e966
guide: more updates to What is DVC? (per 1.x) and
jorgeorpinel 733593c
guide: review intro and reorg Related Technologies
jorgeorpinel 28226d6
Merge branch 'master' into guide/what-is-dvc
jorgeorpinel 7f421dd
guide: add Questions header to best practices (hidden)
jorgeorpinel d390a6f
guide: hide GAPI PP
jorgeorpinel c97e93b
guide: revise Git-LFS section of related techs
jorgeorpinel 30d38df
guide: revise all Git* related techs
jorgeorpinel a450d39
guide: revise remaining related techs
jorgeorpinel a93f24f
guide: remove img from basic concepts
jorgeorpinel 1a6948e
guide: move troubleshooting back out of How To
jorgeorpinel 3e7b18a
Merge branch 'master' into guide/what-is-dvc
jorgeorpinel a556e6c
cases: move Why DVC? to Use Cases index and
jorgeorpinel eb5fbf9
guide: move Basic Principles from What is DVC? into Basic Concepts guide
jorgeorpinel c476f60
guide: remove "User Manual" term from index
jorgeorpinel 3508a19
nav: remove ... from How To entry
jorgeorpinel 2842e3a
tests: finis rolling back troubleshooting guide move
jorgeorpinel 02c2b01
Merge branch 'master' into guide/what-is-dvc
jorgeorpinel 7411f53
cases: fix a link to related techs guide
jorgeorpinel 9c75ae8
Merge branch 'master' into guide/what-is-dvc
jorgeorpinel 98ffea3
guide: propper structure in related techs
jorgeorpinel 95521e6
guide: update remote storage core concept in what is dvc
jorgeorpinel fbd7e96
guide: improve Core Features of What is DVC?
jorgeorpinel 86fbf43
guide: simplify data versioning core feature
jorgeorpinel de43edd
guide: update What is DVC? intro
jorgeorpinel bebd665
guide: simplify Core Features in What is DVC?
jorgeorpinel d8a71f8
guide: features before concepts (index)
jorgeorpinel 722cbb3
guide: review term "features" in basic concepts
jorgeorpinel e6d5f78
guide: undo starting How To subsection
jorgeorpinel ca9203a
guide: undo changes to troubleshooting
jorgeorpinel eebb2e6
guide: a few more copy edits for What is DVC
jorgeorpinel c720552
guide: remove Basic Concepts page
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
guide: revise What is DVC? up to Core Principles and
and create hidden basic-concepts guide
commit 93cc607e23981730e24873810219c78e0c662256
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Basic Concepts of DVC | ||
|
||
- **Cache directory**: Directory with all data files on a local hard drive or in | ||
cloud storage, but not in the Git repository. See `dvc cache dir`. |
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,31 +1,21 @@ | ||
# User Guide | ||
|
||
Our guides describe the main DVC concepts and features comprehensively, | ||
explaining when and how to use them, as well as connections between them. These | ||
guides don't focus on specific scenarios, but have a general scope – like a | ||
_user manual_. Their topics range from more technical foundations, impacting | ||
more parts of DVC, to more advanced and specific things you can do. We also | ||
include a few guides related to contributing to | ||
[this open-source project](https://github.com/iterative/dvc). | ||
Our guides describe the major concepts and features of DVC comprehensively, | ||
explaining when and how to use them, as well as relationship between these. We | ||
don't focus on specific scenarios in this section, but rather on a general scope | ||
– think _User Manual_. The topics here range from more foundational, impacting | ||
jorgeorpinel marked this conversation as resolved.
Show resolved
Hide resolved
|
||
more parts of DVC, to more technical and advanced things you can do. We also | ||
include a few misc. guides, for example related to | ||
[contributing to DVC](/doc/user-guide/contributing/core) itself. | ||
|
||
## Why DVC? | ||
jorgeorpinel marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Even with all the success we've seen today in machine learning (ML), | ||
specifically deep learning and its applications in business, the data science | ||
community still lacks good practices for organizing their projects and | ||
collaborating effectively. This is a critical challenge: we need to evolve | ||
towards ML algorithms and methods no longer being tribal knowledge and making | ||
them easy to implement, reuse, and manage. | ||
|
||
Today the data science community is still lacking good practices for organizing | ||
their projects and effectively collaborating. ML algorithms and methods are no | ||
longer simple tribal knowledge but are still difficult to implement, manage and | ||
reuse. | ||
|
||
> One of the biggest challenges in reusing, and hence the managing of ML | ||
> projects, is its reproducibility. | ||
--- | ||
Even with all the success we've seen today in machine learning (ML), especially | ||
with deep learning and its applications in business, the data science community | ||
still lacks good practices for organizing their projects and collaborating | ||
effectively. This is a critical challenge: while ML algorithms and methods are | ||
no longer tribal knowledge, they are still difficult to implement, reuse, and | ||
manage. | ||
|
||
Please choose from the navigation sidebar to the left, or click the `Next` | ||
button below ↘ |
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
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.
so, how do we connect this with glossary?
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.
I just extracted some info from What is DVC? to this new basic concepts guide that will kickstart #550 but it's not added to the navigation, so it's hidden for now. I know this doc needs lots of work and figure out the glossary connection but I'm leaving all that for a separate PR.
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.
I would say we don't have that much useful info here to keep it
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.
There's a good amount now. And more in #1655
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.
I still don't see much new compared to the glossary in this format. For now it just means two similar places to keep updated for us.
Also it's strange a bit to have advanced concepts in basic concepts. Also, split itself is quite artificial.
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.
To clarify. My take on #550 is that it's way more than a single page like this. Good example of a basic concept is cache, or run cache - they alone can take a proper page I guess.
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.
Noted. We can break it up in #1655. Should we move the discussion there and get this one merged? Or is having the guide here blocking the approval? Because I can just remove it and any links to it for now, and re-introduce it in that other PR. Please lmk
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.
I guess, let's remove it for now and simplify the PR
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.
so, are we removing this?
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.
Oh I read that wrong. I though you said "let's leave it for now". OK, removed now.