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

Restyle Switching out references of Iterative Studio to DVC Studio #4912

Merged
merged 1 commit into from
Oct 20, 2023
Merged
Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions content/docs/studio/experiments.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ DVC Studio offers more ways to run and track experiments - you can:

- set up reproducible pipelines with DVC,
- submit new experiments from the VS Code IDE,
- submit new experiments from DVC Studio, and have them run in your own
cloud infrastructure.
- submit new experiments from DVC Studio, and have them run in your own cloud
infrastructure.

For details on all these, check out the
[`experiment management user guide`](/doc/studio/user-guide/experiments).
Expand Down
10 changes: 5 additions & 5 deletions content/docs/studio/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# DVC Studio

[DVC Studio](https://studio.iterative.ai/) is a web application that
enables Machine Learning teams to seamlessly
[DVC Studio](https://studio.iterative.ai/) is a web application that enables
Machine Learning teams to seamlessly

- [Run and track experiments](/doc/studio/experiments)
- [Manage model lifecycle](/doc/studio/model-registry)
Expand All @@ -11,9 +11,9 @@ It works on top of [DVC](https://dvc.org/) and [Git](https://git-scm.com/),
maintaining Git as the single-source-of-truth for your data, experiments and
models.

Sign in to [DVC Studio](https://studio.iterative.ai/) using your
GitHub.com, GitLab.com, or Bitbucket.org account, or with your email address.
Explore the demo projects and models, and
Sign in to [DVC Studio](https://studio.iterative.ai/) using your GitHub.com,
GitLab.com, or Bitbucket.org account, or with your email address. Explore the
demo projects and models, and
[let us know](/doc/studio/user-guide/troubleshooting#support) if you need any
help getting started.

Expand Down
4 changes: 2 additions & 2 deletions content/docs/studio/model-registry.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Manage models

DVC Studio provides a model registry that you can access by clicking on
the [`Models` tab](https://studio.iterative.ai/user/-/models). Your project's
DVC Studio provides a model registry that you can access by clicking on the
[`Models` tab](https://studio.iterative.ai/user/-/models). Your project's
`dvc.yaml` files are used to identify ML models and
[specially formatted Git tags](/doc/gto/user-guide#git-tags-format) are used to
identify model versions and stage assignments.
Expand Down
4 changes: 2 additions & 2 deletions content/docs/studio/self-hosting/installation/aws-ami.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Replace the strings marked with `< >`
ubuntu@ami:~$ helm install --wait studio iterative/studio --namespace studio -f values.yaml
```

16. You're done! Access DVC Studio by opening the configured hostname in
your browser
16. You're done! Access DVC Studio by opening the configured hostname in your
browser

![](/img/studio-selfhosted-ami-9.png)
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Billing and Payment

DVC Studio is free for individuals and teams with up to 2 members. The Free plan is
designed for teams that are starting out: you can invite one other team member
and import as many repositories as you want.
DVC Studio is free for individuals and teams with up to 2 members. The Free plan
is designed for teams that are starting out: you can invite one other team
member and import as many repositories as you want.

For more advanced collaboration, you can switch to the Basic or Enterprise
plans. These are paid plans, and in this page you will learn how to manage
Expand All @@ -21,8 +21,8 @@ billing and payment for them.

## Difference between Free, Basic, and Enterprise plans

A detailed comparison of the different plans can be found in the DVC
Studio [pricing page](https://studio.iterative.ai/pricing).
A detailed comparison of the different plans can be found in the DVC Studio
[pricing page](https://studio.iterative.ai/pricing).

## How to sign up for the Basic or Enterprise plans

Expand All @@ -42,8 +42,8 @@ details]).

For Basic plans, invoice amount is calculated based on the number of seats in
the team. All invoice amounts are calculated for one billing period at a time. A
billing period is one month long. The price per seat can be found in the
DVC Studio [pricing page](https://studio.iterative.ai/pricing).
billing period is one month long. The price per seat can be found in the DVC
Studio [pricing page](https://studio.iterative.ai/pricing).

For example, suppose you have a team with 5 seats. At a monthly rate of $40 per
seat, the total payable amount for the team would be $40 x 5 = $200 per month.
Expand Down
24 changes: 12 additions & 12 deletions content/docs/studio/user-guide/account-and-billing/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Account Management

To open your account settings, click on your user icon on the top right corner
of DVC Studio, and go to your `Profile`. You can view and update the
following settings:
of DVC Studio, and go to your `Profile`. You can view and update the following
settings:

- [Personal details](#personal-details), including name, username and email
addresses
Expand Down Expand Up @@ -34,9 +34,9 @@ You can edit your name as well as username.

### Managing email addresses

You can add multiple email addresses to a single DVC Studio account. You
can login to the account with any of your verified email addresses as long as
you have set up a password for your account. This is true even if you signed up
You can add multiple email addresses to a single DVC Studio account. You can
login to the account with any of your verified email addresses as long as you
have set up a password for your account. This is true even if you signed up
using your GitHub, GitLab, or Bitbucket.

One of your email addresses must be designated as primary. This is the address
Expand Down Expand Up @@ -208,11 +208,11 @@ In this section, you can,

- Connect to GitHub.com, GitLab.com or Bitbucket.org.

When you connect to a Git hosting provider, you will be prompted to grant
DVC Studio access to your account.
When you connect to a Git hosting provider, you will be prompted to grant DVC
Studio access to your account.

To connect to your GitHub repositories, you must install the DVC Studio
GitHub app. Refer to the section on
To connect to your GitHub repositories, you must install the DVC Studio GitHub
app. Refer to the section on
[GitHub app installation](/doc/studio/user-guide/git-integrations/github-app)
for more details.

Expand All @@ -227,9 +227,9 @@ In this section, you can,
in the [team settings].

- Disconnect from your GitHub, GitLab, or Bitbucket accounts.
- Configure your GitHub account connection. That is, install the DVC
Studio GitHub app on additional organizations or repositories, or even remove
the app from organizations or repositories where you no longer need it.
- Configure your GitHub account connection. That is, install the DVC Studio
GitHub app on additional organizations or repositories, or even remove the app
from organizations or repositories where you no longer need it.

## Delete account

Expand Down
22 changes: 10 additions & 12 deletions content/docs/studio/user-guide/experiments/configure-a-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ during the initial [create project] flow.
Here, the [data remotes](/doc/user-guide/data-management/remote-storage) (cloud
storage or another location outside the Git repo) that are used in your DVC repo
will be listed. If you want your project to include data stored in these data
remotes, you will have to add credentials to grant DVC Studio access to
the data remotes. Credentials that you have already added to your account are
listed in this section, and you can select them to add them to the project.
remotes, you will have to add credentials to grant DVC Studio access to the data
remotes. Credentials that you have already added to your account are listed in
this section, and you can select them to add them to the project.

![](https://static.iterative.ai/img/studio/view_settings_credentials.png)

Expand All @@ -65,8 +65,8 @@ Any credentials that you
[add in your profile page](/doc/studio/user-guide/account-and-billing#cloud-credentials)
are also available in your project settings page.

Note that DVC Studio uses the credentials only to read plots/metrics files
if they are not saved in Git. It does not access any other data in your remote
Note that DVC Studio uses the credentials only to read plots/metrics files if
they are not saved in Git. It does not access any other data in your remote
storage. And you do not need to provide the credentials if any DVC data remote
is not used in your Git repository.

Expand All @@ -78,8 +78,7 @@ is not used in your Git repository.
## Commits and columns

You can specify which Git commits and columns should be imported from your Git
repository to your project in DVC Studio, and which ones should be
excluded.
repository to your project in DVC Studio, and which ones should be excluded.

### Start date/time

Expand Down Expand Up @@ -107,11 +106,10 @@ If your project is missing some required columns, then it is likely that
<admon type="warn">

The **Columns** setting was earlier called **Tracking scope** or **Mandatory
columns** and behaved slightly differently. DVC Studio would always import
up to 200 columns. This meant that if you selected only 5 columns, DVC
Studio would still import another 195 columns, unless your repository did not
have so many columns. This behavior is now obsolete, and only selected columns
are imported.
columns** and behaved slightly differently. DVC Studio would always import up to
200 columns. This meant that if you selected only 5 columns, DVC Studio would
still import another 195 columns, unless your repository did not have so many
columns. This behavior is now obsolete, and only selected columns are imported.

</admon>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ In this section, you will learn how to:

To add a new project, follow these steps.

1. Sign in to [DVC Studio](https://studio.iterative.ai/) using your
GitHub.com, GitLab.com, or Bitbucket.org account, or with your email address.
1. Sign in to [DVC Studio](https://studio.iterative.ai/) using your GitHub.com,
GitLab.com, or Bitbucket.org account, or with your email address.

2. Click on `Add a Project`. All the organizations that you have access to will
be listed.
Expand Down Expand Up @@ -70,8 +70,8 @@ You should now see that the project has been added in your dashboard.

## Create multiple projects from a single Git repository

You can create multiple projects in DVC Studio from a single Git
repository and apply different settings to them.
You can create multiple projects in DVC Studio from a single Git repository and
apply different settings to them.

One use case for this is if you have a
**[monorepo](https://en.wikipedia.org/wiki/Monorepo)** with multiple ML
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Explore ML Experiments

The projects dashboard in DVC Studio contains all your projects. Click on
a project name to open the project table, which contains:
The projects dashboard in DVC Studio contains all your projects. Click on a
project name to open the project table, which contains:

- [Git history and live experiments](#git-history-and-live-metrics) of the
project
Expand Down Expand Up @@ -58,13 +58,13 @@ When a Git branch (e.g., `feature-branch-1`) is created from another branch
- if the user has merged `feature-branch-1` into `main` and has not pushed any
new commits to it after the merger.

Since the branch does not contain any new unique commits, DVC Studio
considers `feature-branch-1` as **"nested"** within `main` and does not
display it as a separate branch. This helps to keep the project table concise
and reduce clutter that can accumulate over time when inactive branches are
not cleaned from the Git repository. After all, those inactive branches
usually carry no new information for the purpose of managing experiments. If
you would like to display all commits of such an inactive branch, use the
Since the branch does not contain any new unique commits, DVC Studio considers
`feature-branch-1` as **"nested"** within `main` and does not display it as a
separate branch. This helps to keep the project table concise and reduce
clutter that can accumulate over time when inactive branches are not cleaned
from the Git repository. After all, those inactive branches usually carry no
new information for the purpose of managing experiments. If you would like to
display all commits of such an inactive branch, use the
[`Commits on branch = feature-branch-1` display filter](#filters).

## Display preferences
Expand Down Expand Up @@ -138,13 +138,13 @@ dropdown.

Commits can be hidden from the project table in the following ways:

- **DVC Studio auto-hides irrelevant commits:** DVC Studio
identifies commits where metrics, files and hyperparameters did not change and
hides them automatically.
- **DVC Studio auto-hides commits that contain `[skip studio]` in the
commit message:** This is particularly useful if your workflow creates
multiple commits per experiment and you would like to hide all those commits
except the final one.
- **DVC Studio auto-hides irrelevant commits:** DVC Studio identifies commits
where metrics, files and hyperparameters did not change and hides them
automatically.
- **DVC Studio auto-hides commits that contain `[skip studio]` in the commit
message:** This is particularly useful if your workflow creates multiple
commits per experiment and you would like to hide all those commits except the
final one.

For example, suppose you create a Git commit with hyper-parameter changes for
running a new experiment, and your training CI job creates a new Git commit
Expand Down Expand Up @@ -184,8 +184,8 @@ toggle between these two options, use the `Delta mode` button.

Whenever you make any changes to your project's columns, commits or filters, a
notification to save or discard your changes is displayed at the top of the
project table. Saved changes remain intact even after you log out of DVC
Studio and log back in later.
project table. Saved changes remain intact even after you log out of DVC Studio
and log back in later.

![Save or discard changes](https://static.iterative.ai/img/studio/save_discard_changes.png)

Expand Down
14 changes: 7 additions & 7 deletions content/docs/studio/user-guide/experiments/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Jupyter Notebooks, a code editor or IDE like [VS Code](/doc/vs-code-extension),
the Python cli, the bash terminal, etc. You can also [submit new experiments
from DVC Studio][run-experiments].

You can track live as well as completed experiments in DVC Studio. First,
click on `Add a project` to connect DVC Studio to your ML project's Git
repository. Then, follow the instructions presented below.
You can track live as well as completed experiments in DVC Studio. First, click
on `Add a project` to connect DVC Studio to your ML project's Git repository.
Then, follow the instructions presented below.

## Track experiments in real-time

Expand Down Expand Up @@ -103,8 +103,8 @@ To set up, run and track
dvc exp push origin <exp_name>
```

- DVC Studio reads the values of metrics, plots and other details from
your project's `dvc.yaml` file, and displays them in an experiment row in the
- DVC Studio reads the values of metrics, plots and other details from your
project's `dvc.yaml` file, and displays them in an experiment row in the
project table. The experiment row will appear nested within the parent Git
commit row.

Expand All @@ -123,8 +123,8 @@ Within a project, you can:
- [Compare experiments][compare].
- [Run new experiments][run-experiments], including on your own cloud instances,
directly from DVC Studio.
- [Track live metrics and plots][live-metrics-and-plots] by sending them to
DVC Studio by using [DVCLive].
- [Track live metrics and plots][live-metrics-and-plots] by sending them to DVC
Studio by using [DVCLive].

[explore-ml-experiments]:
/doc/studio/user-guide/experiments/explore-ml-experiments
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ This requires a 2-step process:

DVC Studio uses access tokens to authorize DVC and [DVCLive] to send live
experiment updates. The access token must be present in any request that sends
data to the DVC Studio ingestion endpoint. Requests with missing or
incorrect access tokens are rejected with an appropriate HTTP error code and
error message. The access token is also used by DVC to notify DVC Studio
when you push experiments using `dvc exp push`.
data to the DVC Studio ingestion endpoint. Requests with missing or incorrect
access tokens are rejected with an appropriate HTTP error code and error
message. The access token is also used by DVC to notify DVC Studio when you push
experiments using `dvc exp push`.

Once you [create your access token], pass it to your experiment. If you are
running the experiment locally, you can set the token in your [DVC config]. For
Expand Down Expand Up @@ -45,9 +45,9 @@ steps:

In the training job (which has been configured as detailed above), whenever you
log your metrics or plots using [DVCLive], they will be automatically sent to
DVC Studio. See [DVC config] for how to enable/disable live experiment
updates and how to configure a different Studio URL or Git repository. Here is
an example of how you can use [DVCLive] in your training code:
DVC Studio. See [DVC config] for how to enable/disable live experiment updates
and how to configure a different Studio URL or Git repository. Here is an
example of how you can use [DVCLive] in your training code:

```py
from dvclive import Live
Expand All @@ -71,10 +71,10 @@ automatically called when the experiment concludes successfully.

### Live experiments in DVC Studio

DVC Studio stores the live experiments data in its database. In the
project table, the live experiments are displayed in experiment rows, which are
nested under the parent Git commit. Updates to the live experiments are
highlighted (in orange) in the project table and
DVC Studio stores the live experiments data in its database. In the project
table, the live experiments are displayed in experiment rows, which are nested
under the parent Git commit. Updates to the live experiments are highlighted (in
orange) in the project table and
[compare pane](/doc/studio/user-guide/experiments/visualize-and-compare#compare-experiments)
in real time.

Expand Down Expand Up @@ -119,26 +119,26 @@ You can also delete the detached experiments if they are no longer important.

An experiment can have one of the following statuses:

- **Running** - DVC Studio expects to receive live metrics and plots for
these experiments.
- **Running** - DVC Studio expects to receive live metrics and plots for these
experiments.

<admon type="warn">

If the experiment stops due to any error, DVC Studio will not be aware
of this and it will continue to wait for live updates. In this case, you can
delete the row from the project table.
If the experiment stops due to any error, DVC Studio will not be aware of this
and it will continue to wait for live updates. In this case, you can delete
the row from the project table.

</admon>

- **Completed** - DVC Studio does not expect to receive any more updates
for these experiments. Once the experiment concludes, you can delete the row
from the project table.
- **Completed** - DVC Studio does not expect to receive any more updates for
these experiments. Once the experiment concludes, you can delete the row from
the project table.

<admon type="warn">

DVC Studio does not automatically commit and push the final results of
your experiment to Git. You can [push] the experiment using appropriate DVC
and Git commands.
DVC Studio does not automatically commit and push the final results of your
experiment to Git. You can [push] the experiment using appropriate DVC and Git
commands.

</admon>

Expand Down
Loading
Loading