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

fix typos in documentation #151

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs/markdowns/model_versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Use-cases:

Currently, many organizations manage their experiments by saving snapshots of the data, the logs, the metrics and the
models. The best performing models are copied to a different location for deployment to dev and production environments,
which are ometimes managed by a database, or with docker-image registry. Often, another third-party tool is used to
which are sometimes managed by a database, or with docker-image registry. Often, another third-party tool is used to
manage experiments, which then needs to be integrated with the rest of the development stack.

*An example:*
Expand Down Expand Up @@ -76,7 +76,7 @@ And this doesn't even cover other common use cases like sharing data or models w

## ML experimentation with pyxet and XetHub

With XetHub, we can use Git to manage every part of your ML experiments by storing models and assest alongside your code.
With XetHub, we can use Git to manage every part of your ML experiments by storing models and assets alongside your code.
Optionally, use [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to manage only large data on XetHub.


Expand Down Expand Up @@ -115,8 +115,8 @@ We can always reproduce results and compare models by checking out branches and

Start a new experiment branch from any existing one, pull new data with `git submodule update data` and run the training
again. XetHub will overwrite the model, metrics, and checkpoints in the new branch, and if the pull request review is
successful, merge the changes back to prod. This ensures that the model in prod is always up-to-date, and that its
always stored alongside its metrics, inference code and relevant logs.
successful, merge the changes back to prod. This ensures that the model in prod is always up-to-date, and that it's
always stored alongside its metrics, inference code and relevant logs.

Everything **this** model needs is saved in the repo. If changes to the app are needed, they are managed together.