-
Notifications
You must be signed in to change notification settings - Fork 394
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Re-organize the Studio docs to make it easy for users to get started …
…with our 2 major features - experiments and model registry
- Loading branch information
tapadipti
committed
Sep 12, 2023
1 parent
7711121
commit c662aae
Showing
22 changed files
with
299 additions
and
229 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Run and track experiments | ||
|
||
1. A project displays your live and complete experiments, including Git commits | ||
and refs. For each experiment, you can compare metrics, parameters, plots, | ||
and other files. | ||
|
||
![Project table with live plots](https://static.iterative.ai/img/studio/project-table-with-live-plots.gif) | ||
|
||
2. Click on `Add a Project` and connect to the Git repository for your Machine | ||
Learning project. | ||
|
||
3. Iterative Studio offers a | ||
[few different ways to track your experiments](/doc/studio/user-guide/experiments#different-ways-to-track-experiments). | ||
To get started quickly, you can track experiments in real-time using | ||
[DVCLive]: | ||
|
||
- Install DVCLive: | ||
|
||
`pip install dvclive` | ||
|
||
- Copy your DVC Studio token and configure your model training environment to | ||
use the token: | ||
|
||
`dvc config --global studio.token ***` | ||
|
||
- Add DVCLive to your model training code: | ||
|
||
```python | ||
from dvclive import Live | ||
with Live(save_dvc_exp=True) as live: | ||
for epoch in range(epochs): | ||
live.log_metric("accuracy", accuracy) | ||
live.log_metric("loss", loss) | ||
live.next_step() | ||
``` | ||
|
||
- Run the training job: | ||
|
||
`python train.py` | ||
|
||
4. The metrics will be updated in the project table in real-time. | ||
|
||
5. Open the `Plots` pane to view the live updates to your plots. | ||
|
||
For more details, check out the | ||
[`experiment management user guide`](/doc/studio/user-guide/experiments). | ||
|
||
[project settings]: | ||
/doc/studio/user-guide/projects-and-experiments/configure-a-project | ||
[when do you need project settings]: | ||
/doc/studio/user-guide/projects-and-experiments/configure-a-project#scenarios-where-project-settings-are-required | ||
[create multiple projects from a single git repository]: | ||
/doc/studio/user-guide/projects-and-experiments/create-a-project#create-multiple-projects-from-a-single-git-repository | ||
[explore ml experiments]: | ||
/doc/studio/user-guide/projects-and-experiments/explore-ml-experiments | ||
[create a team]: /doc/studio/user-guide/teams | ||
[sign up for the **basic** or **enterprise** plan]: | ||
/doc/studio/user-guide/change-team-plan-and-size | ||
[make your projects public]: | ||
/doc/studio/user-guide/projects-and-experiments/share-a-project | ||
[train on the cloud, including on your own cloud infrastructure, and submit new experiments]: | ||
/doc/studio/user-guide/projects-and-experiments/run-experiments | ||
[live-metrics-and-plots]: | ||
/doc/studio/user-guide/projects-and-experiments/live-metrics-and-plots | ||
[dvclive]: /doc/dvclive | ||
[monorepo]: | ||
/doc/studio/user-guide/projects-and-experiments/configure-a-project#monorepo |
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Manage models | ||
|
||
1. Click on the `Models` tab to open the central [Models dashboard]. Iterative | ||
Studio uses your project's `dvc.yaml` files to identify ML models and | ||
specially formatted Git tags to identify model versions and stage | ||
assignments. | ||
|
||
[models dashboard]: | ||
/doc/studio/user-guide/model-registry/view-and-compare-models#models-dashboard | ||
|
||
2. Click on the model name to | ||
[open its details page](/doc/studio/user-guide/model-registry/view-and-compare-models#model-details-page). | ||
|
||
3. You can perform the following actions to manage the lifecycle of models: | ||
- [Add models to the registry](/doc/studio/user-guide/model-registry/add-a-model) | ||
- [Register new versions of the models](/doc/studio/user-guide/model-registry/register-version) | ||
(like `v0.0.1` and `v1.0.0`) | ||
- [Assign stages to model versions](/doc/studio/user-guide/model-registry/assign-stage) | ||
(e.g. `dev`, `testing`, `prod`) | ||
- Use models: | ||
[download them](/doc/studio/user-guide/model-registry/use-models) or | ||
[set up CI/CD](/doc/studio/user-guide/model-registry/use-models) to publish | ||
or deploy models | ||
|
||
For more details, check out the | ||
[`model registry user guide`](/doc/studio/user-guide/model-registry/). |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.