Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

Restyle GTO: updating docs #252

Closed
wants to merge 1 commit into from
Closed

Restyle GTO: updating docs #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions content/docs/gto/user-guide/dvc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# GTO with DVC

Large files are typically not stored in a Git repository, so they need to be
downloaded from external sources. [DVC](https://dvc.org) is a great way to
store your GTO artifact files while keeping a pointer in the
repo, and simplifying [data management] and synchronization.
downloaded from external sources. [DVC](https://dvc.org) is a great way to store
your GTO artifact files while keeping a pointer in the repo, and simplifying
[data management] and synchronization.

[data management]: https://dvc.org/doc/user-guide/data-management

Expand All @@ -24,8 +24,7 @@ repo, and simplifying [data management] and synchronization.

<admon icon="book">

If you're new to DVC,
[get started here](https://dvc.org/doc/start) first.
If you're new to DVC, [get started here](https://dvc.org/doc/start) first.

</admon>

Expand Down
14 changes: 6 additions & 8 deletions content/docs/gto/user-guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,13 @@

GTO helps you build an Artifact Registry out of your Git repository. It creates
annotated [Git tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging) with a
[special format](#git-tags-format), and manages an
`artifacts.yaml` file.
[special format](#git-tags-format), and manages an `artifacts.yaml` file.

<admon type="tip">

Storing large files in Git repos is not a good practice.
Avoid committing your ML artifacts to Git. You can
[use DVC](/doc/gto/user-guide/dvc), Git LFS, or any other method to commit pointers to
the data, models, etc. instead.
Storing large files in Git repos is not a good practice. Avoid committing your
ML artifacts to Git. You can [use DVC](/doc/gto/user-guide/dvc), Git LFS, or any
other method to commit pointers to the data, models, etc. instead.

</admon>

Expand All @@ -24,8 +22,8 @@ itself doesn't contain path to the artifact, type of it (it could be `model` or
we should codify them in the registry itself.

To keep this metadata, GTO uses a human-readable `artifacts.yaml` file. The
`gto describe`, `gto annotate`, and `gto remove` commands are used to display and
manage it's contents.
`gto describe`, `gto annotate`, and `gto remove` commands are used to display
and manage it's contents.

<admon type="tip">

Expand Down