From 1378618be1648cb3dd3daf7c28a48787827a7b0b Mon Sep 17 00:00:00 2001 From: Jenifer De Figueiredo Date: Tue, 10 Oct 2023 15:34:42 +0000 Subject: [PATCH] Switching out references of Iterative Studio to DVC Studio --- content/docs/dvclive/live/log_image.md | 2 +- content/docs/studio/experiments.md | 10 ++-- content/docs/studio/index.md | 8 ++-- content/docs/studio/model-registry.md | 10 ++-- .../self-hosting/installation/aws-ami.md | 2 +- .../studio/self-hosting/installation/index.md | 2 +- .../billing-and-payment.md | 6 +-- .../user-guide/account-and-billing/index.md | 18 ++++---- .../experiments/configure-a-project.md | 10 ++-- .../experiments/create-a-project.md | 10 ++-- .../experiments/explore-ml-experiments.md | 10 ++-- .../studio/user-guide/experiments/index.md | 16 +++---- .../experiments/live-metrics-and-plots.md | 22 ++++----- .../user-guide/experiments/run-experiments.md | 34 +++++++------- .../user-guide/experiments/share-a-project.md | 4 +- .../experiments/visualize-and-compare.md | 4 +- .../git-integrations/custom-gitlab-server.md | 6 +-- .../user-guide/git-integrations/github-app.md | 12 ++--- .../user-guide/git-integrations/index.md | 4 +- .../user-guide/model-registry/add-a-model.md | 14 +++--- .../user-guide/model-registry/assign-stage.md | 6 +-- .../studio/user-guide/model-registry/index.md | 2 +- .../model-registry/register-version.md | 4 +- .../remove-a-model-or-its-details.md | 4 +- .../user-guide/model-registry/use-models.md | 2 +- .../model-registry/view-and-compare-models.md | 4 +- .../change-team-plan-and-size.md | 6 +-- .../user-guide/team-collaboration/index.md | 6 +-- .../docs/studio/user-guide/troubleshooting.md | 46 +++++++++---------- .../user-guide/experiment-management/index.md | 6 +-- .../project-structure/configuration.md | 2 +- 31 files changed, 146 insertions(+), 146 deletions(-) diff --git a/content/docs/dvclive/live/log_image.md b/content/docs/dvclive/live/log_image.md index 3bdab6911d..a96f89c2d7 100644 --- a/content/docs/dvclive/live/log_image.md +++ b/content/docs/dvclive/live/log_image.md @@ -92,7 +92,7 @@ with Live() as live: live.next_step() ``` -In [Iterative Studio](https://studio.iterative.ai/) and the +In [DVC Studio](https://studio.iterative.ai/) and the [DVC Extension for VSCode](https://marketplace.visualstudio.com/items?itemName=Iterative.dvc), folders following this pattern will be rendered using an image slider: diff --git a/content/docs/studio/experiments.md b/content/docs/studio/experiments.md index df7d68d857..791a44ee4e 100644 --- a/content/docs/studio/experiments.md +++ b/content/docs/studio/experiments.md @@ -3,9 +3,9 @@ You can submit your experiments from your favorite interface - whether it is Jupyter Notebooks, a code editor or IDE like [VS Code](/doc/vs-code-extension), the Python cli, the bash terminal, etc. To quickly start tracking your -experiments with Iterative Studio: +experiments with DVC Studio: -- Click on `Add a project` to connect Iterative Studio to your ML project's Git +- Click on `Add a project` to connect DVC Studio to your ML project's Git repository. - In your model training environment, install [DVCLive]: @@ -42,15 +42,15 @@ experiments with Iterative Studio: ``` - The metrics and plots will be [tracked live][live-metrics-and-plots] in the - project in Iterative Studio. + project in DVC Studio. ## More ways to run and track experiments -Iterative Studio offers more ways to run and track experiments - you can: +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 Iterative Studio, and have them run in your own +- submit new experiments from DVC Studio, and have them run in your own cloud infrastructure. For details on all these, check out the diff --git a/content/docs/studio/index.md b/content/docs/studio/index.md index d276e46a54..5501147b79 100644 --- a/content/docs/studio/index.md +++ b/content/docs/studio/index.md @@ -1,6 +1,6 @@ -# Iterative Studio +# DVC Studio -[Iterative Studio](https://studio.iterative.ai/) is a web application that +[DVC Studio](https://studio.iterative.ai/) is a web application that enables Machine Learning teams to seamlessly - [Run and track experiments](/doc/studio/experiments) @@ -11,7 +11,7 @@ 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 [Iterative Studio](https://studio.iterative.ai/) using your +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 @@ -19,7 +19,7 @@ help getting started. https://www.youtube.com/watch?v=w-UjAbdpRY4 -## Why Iterative Studio? +## Why DVC Studio? - Simplify ML experiment tracking, visualization, and collaboration on top of Git. diff --git a/content/docs/studio/model-registry.md b/content/docs/studio/model-registry.md index 3b50fef8fd..26d0b696c7 100644 --- a/content/docs/studio/model-registry.md +++ b/content/docs/studio/model-registry.md @@ -1,14 +1,14 @@ # Manage models -Iterative Studio provides a model registry that you can access by clicking on +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. -To quickly start tracking your models in the Iterative Studio model registry: +To quickly start tracking your models in the DVC Studio model registry: -- Click on `Add a project` to connect Iterative Studio to your ML project's Git +- Click on `Add a project` to connect DVC Studio to your ML project's Git repository. - In your model training environment, install [DVCLive](/doc/dvclive): @@ -49,10 +49,10 @@ To quickly start tracking your models in the Iterative Studio model registry: ## More ways to add models -Iterative Studio offers more ways to add models to the model registry - you can: +DVC Studio offers more ways to add models to the model registry - you can: - edit `dvc.yaml` directly and add your model to artifacts section, or -- add models from the Iterative Studio interface. +- add models from the DVC Studio interface. Find the complete tutorial [here](/doc/studio/user-guide/model-registry/add-a-model). diff --git a/content/docs/studio/self-hosting/installation/aws-ami.md b/content/docs/studio/self-hosting/installation/aws-ami.md index b8058ce720..98c2e5edf0 100644 --- a/content/docs/studio/self-hosting/installation/aws-ami.md +++ b/content/docs/studio/self-hosting/installation/aws-ami.md @@ -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 Iterative Studio by opening the configured hostname in +16. You're done! Access DVC Studio by opening the configured hostname in your browser ![](/img/studio-selfhosted-ami-9.png) diff --git a/content/docs/studio/self-hosting/installation/index.md b/content/docs/studio/self-hosting/installation/index.md index b5a3d3251a..6e34555e65 100644 --- a/content/docs/studio/self-hosting/installation/index.md +++ b/content/docs/studio/self-hosting/installation/index.md @@ -1,6 +1,6 @@ ## Self-hosting Studio -Studio Enterprise users can host Iterative Studio on their own infrastructure +Studio Enterprise users can host DVC Studio on their own infrastructure (on-premises) or in their cloud accounts. Please note that our support is needed to make the Studio's cloud/Docker images diff --git a/content/docs/studio/user-guide/account-and-billing/billing-and-payment.md b/content/docs/studio/user-guide/account-and-billing/billing-and-payment.md index ad6eb0254c..43ac3056e8 100644 --- a/content/docs/studio/user-guide/account-and-billing/billing-and-payment.md +++ b/content/docs/studio/user-guide/account-and-billing/billing-and-payment.md @@ -43,7 +43,7 @@ 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 -Iterative Studio [pricing page](https://studio.iterative.ai/pricing). +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. @@ -107,7 +107,7 @@ subscription at the end of the billing period. At the end of your billing period, if we are unable to process your payment, you will enter a grace period of 5 days during which you must provide valid payment. -During this time you will continue to have full access to Iterative Studio. +During this time you will continue to have full access to DVC Studio. Your account's primary email address will be notified after each failed payment. Payments may be retried up to 4 times. To provide a new payment method, go to @@ -139,6 +139,6 @@ you see your payment history and get a copy of your invoices. ## Other questions -You can find answers to other frequently asked questions in the Iterative Studio +You can find answers to other frequently asked questions in the DVC Studio [FAQ page](https://studio.iterative.ai/faq). If you have any other questions, please [contact us]. diff --git a/content/docs/studio/user-guide/account-and-billing/index.md b/content/docs/studio/user-guide/account-and-billing/index.md index fd3a8bf571..9d7f610e11 100644 --- a/content/docs/studio/user-guide/account-and-billing/index.md +++ b/content/docs/studio/user-guide/account-and-billing/index.md @@ -1,7 +1,7 @@ # Account Management To open your account settings, click on your user icon on the top right corner -of Iterative Studio, and go to your `Profile`. You can view and update the +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 @@ -34,13 +34,13 @@ You can edit your name as well as username. ### Managing email addresses -You can add multiple email addresses to a single Iterative Studio account. You +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 -to which Iterative Studio will send all your account notification emails. +to which DVC Studio will send all your account notification emails. You can change your primary email address by clicking on the `Primary` button next to the email address which you want to designate as primary. @@ -54,7 +54,7 @@ page. ### Studio access token -Iterative Studio uses access tokens to authorize [DVC] and [DVCLive] to send +DVC Studio uses access tokens to authorize [DVC] and [DVCLive] to send experiment updates. In the `Studio access token` section of your [Profile] page, you can generate a @@ -209,14 +209,14 @@ 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 - Iterative Studio access to your account. + DVC Studio access to your account. - To connect to your GitHub repositories, you must install the Iterative Studio + 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. - Note that if you signed up to use Iterative Studio using your GitHub, GitLb or + Note that if you signed up to use DVC Studio using your GitHub, GitLb or Bitbucket account, integration with that Git account will have been created during sign up. @@ -227,7 +227,7 @@ 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 Iterative +- 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. @@ -239,7 +239,7 @@ are absolutely sure that you do not need those projects or links anymore. -Deleting your account in Iterative Studio does not delete your Git repositories. +Deleting your account in DVC Studio does not delete your Git repositories. diff --git a/content/docs/studio/user-guide/experiments/configure-a-project.md b/content/docs/studio/user-guide/experiments/configure-a-project.md index a1ad67cf15..693c8a869e 100644 --- a/content/docs/studio/user-guide/experiments/configure-a-project.md +++ b/content/docs/studio/user-guide/experiments/configure-a-project.md @@ -41,7 +41,7 @@ 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 Iterative Studio access to +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. @@ -65,7 +65,7 @@ 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 Iterative Studio uses the credentials only to read plots/metrics files +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. @@ -78,7 +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 Iterative Studio, and which ones should be +repository to your project in DVC Studio, and which ones should be excluded. ### Start date/time @@ -107,8 +107,8 @@ If your project is missing some required columns, then it is likely that The **Columns** setting was earlier called **Tracking scope** or **Mandatory -columns** and behaved slightly differently. Iterative Studio would always import -up to 200 columns. This meant that if you selected only 5 columns, Iterative +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. diff --git a/content/docs/studio/user-guide/experiments/create-a-project.md b/content/docs/studio/user-guide/experiments/create-a-project.md index 075a15c008..437aed01d2 100644 --- a/content/docs/studio/user-guide/experiments/create-a-project.md +++ b/content/docs/studio/user-guide/experiments/create-a-project.md @@ -10,7 +10,7 @@ In this section, you will learn how to: To add a new project, follow these steps. -1. Sign in to [Iterative Studio](https://studio.iterative.ai/) using your +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 @@ -22,7 +22,7 @@ To add a new project, follow these steps. that [the connection to your Git server has been set up](/doc/studio/user-guide/account-and-billing#git-integrations). - To connect to your GitHub repositories, you must install the Iterative Studio + 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. @@ -59,7 +59,7 @@ To add a new project, follow these steps. You can create multiple projects at once by providing up to 10 - comma-separated values. Iterative Studio will create one project for each + comma-separated values. DVC Studio will create one project for each sub-directory in the list. @@ -70,7 +70,7 @@ 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 Iterative Studio from a single Git +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 @@ -82,7 +82,7 @@ For each ML project in the monorepo, follow the the Git repository. On the additional settings page [specify the sub-directory] (or up to 10 comma-separated values) in which the desired ML project resides. -This way, you will have multiple Iterative Studio projects for your single Git +This way, you will have multiple DVC Studio projects for your single Git repository, with each project presenting values from a different sub-directory. [specify the sub-directory]: diff --git a/content/docs/studio/user-guide/experiments/explore-ml-experiments.md b/content/docs/studio/user-guide/experiments/explore-ml-experiments.md index 18649fd7ec..710c7b0371 100644 --- a/content/docs/studio/user-guide/experiments/explore-ml-experiments.md +++ b/content/docs/studio/user-guide/experiments/explore-ml-experiments.md @@ -1,6 +1,6 @@ # Explore ML Experiments -The projects dashboard in Iterative Studio contains all your projects. Click on +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 @@ -58,7 +58,7 @@ 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, Iterative Studio + 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 @@ -138,10 +138,10 @@ dropdown. Commits can be hidden from the project table in the following ways: -- **Iterative Studio auto-hides irrelevant commits:** Iterative Studio +- **DVC Studio auto-hides irrelevant commits:** DVC Studio identifies commits where metrics, files and hyperparameters did not change and hides them automatically. -- **Iterative Studio auto-hides commits that contain `[skip studio]` in the +- **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. @@ -184,7 +184,7 @@ 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 Iterative +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) diff --git a/content/docs/studio/user-guide/experiments/index.md b/content/docs/studio/user-guide/experiments/index.md index 4f3be2625e..4c9d80d3ac 100644 --- a/content/docs/studio/user-guide/experiments/index.md +++ b/content/docs/studio/user-guide/experiments/index.md @@ -3,15 +3,15 @@ You can submit your experiments from your favorite interface - whether it is 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 Iterative Studio][run-experiments]. +from DVC Studio][run-experiments]. -You can track live as well as completed experiments in Iterative Studio. First, -click on `Add a project` to connect Iterative Studio to your ML project's Git +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 -To quickly start tracking your experiments with Iterative Studio: +To quickly start tracking your experiments with DVC Studio: - In your model training environment, install [DVCLive]: @@ -54,7 +54,7 @@ To quickly start tracking your experiments with Iterative Studio: ``` - The metrics and plots will be [tracked live][live-metrics-and-plots] in the - project in Iterative Studio. + project in DVC Studio. ## Track reproducible pipelines @@ -103,7 +103,7 @@ To set up, run and track dvc exp push origin ``` -- Iterative Studio reads the values of metrics, plots and other details from +- 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. @@ -122,9 +122,9 @@ Within a project, you can: - [Visualize the experiments][visualize] using plots and trend charts. - [Compare experiments][compare]. - [Run new experiments][run-experiments], including on your own cloud instances, - directly from Iterative Studio. + directly from DVC Studio. - [Track live metrics and plots][live-metrics-and-plots] by sending them to - Iterative Studio by using [DVCLive]. + DVC Studio by using [DVCLive]. [explore-ml-experiments]: /doc/studio/user-guide/experiments/explore-ml-experiments diff --git a/content/docs/studio/user-guide/experiments/live-metrics-and-plots.md b/content/docs/studio/user-guide/experiments/live-metrics-and-plots.md index 137da86830..38d87e6729 100644 --- a/content/docs/studio/user-guide/experiments/live-metrics-and-plots.md +++ b/content/docs/studio/user-guide/experiments/live-metrics-and-plots.md @@ -2,7 +2,7 @@ In your model training script, you can use [DVCLive] to send live updates for metrics and plots without writing them to your Git repository, so that you can -track your experiments in real-time from Iterative Studio. +track your experiments in real-time from DVC Studio. This requires a 2-step process: @@ -11,11 +11,11 @@ This requires a 2-step process: ## Set up an access token -Iterative Studio uses access tokens to authorize DVC and [DVCLive] to send live +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 Iterative Studio ingestion endpoint. Requests with missing or +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 Iterative Studio +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 @@ -45,7 +45,7 @@ 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 -Iterative Studio. See [DVC config] for how to enable/disable live experiment +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: @@ -69,9 +69,9 @@ automatically called when the experiment concludes successfully. -### Live experiments in Iterative Studio +### Live experiments in DVC Studio -Iterative Studio stores the live experiments data in its database. In the +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 @@ -119,24 +119,24 @@ You can also delete the detached experiments if they are no longer important. An experiment can have one of the following statuses: -- **Running** - Iterative Studio expects to receive live metrics and plots for +- **Running** - DVC Studio expects to receive live metrics and plots for these experiments. - If the experiment stops due to any error, Iterative Studio will not be aware + 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. -- **Completed** - Iterative Studio does not expect to receive any more updates +- **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. - Iterative Studio does not automatically commit and push the final results of + 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. diff --git a/content/docs/studio/user-guide/experiments/run-experiments.md b/content/docs/studio/user-guide/experiments/run-experiments.md index 71beeefafc..e99f59096b 100644 --- a/content/docs/studio/user-guide/experiments/run-experiments.md +++ b/content/docs/studio/user-guide/experiments/run-experiments.md @@ -1,6 +1,6 @@ # Run Experiments -Iterative Studio can train your model and run experiments with different +DVC Studio can train your model and run experiments with different hyperparameters or datasets. Experiments can be - [Cloud experiments](#cloud-experiments), that run on your own cloud, @@ -12,7 +12,7 @@ hyperparameters or datasets. Experiments can be > that are provided to you by default (such as the [`example-get-started` demo > project][example-get-started project]). Once you connect to your ML project > repositories, you can follow the instructions given below to run experiments -> directly from Iterative Studio. +> directly from DVC Studio. ## Cloud experiments @@ -59,7 +59,7 @@ Once you have added credentials, navigate to the project and follow these steps: ### Monitor a running experiment -Once you submit an experiment, Iterative Studio creates the cloud instance and +Once you submit an experiment, DVC Studio creates the cloud instance and runs the job script. A new row is created in the experiments table under the original Git commit. [Live updates to metrics and plots] generated by [DVCLive] will show up in this row, and you can click on the experiment name to view the @@ -72,9 +72,9 @@ status and output log of the running experiment task. When the experiment completes, the files (including code, data, models, parameters, metrics, and plots) are pushed back to your Git and DVC remotes. -In Iterative Studio, you can create a branch and pull/merge request from the +In DVC Studio, you can create a branch and pull/merge request from the completed experiment, so that you can share, review, merge, and reproduce the -experiment. In the pull/merge request, Iterative Studio automatically inserts a +experiment. In the pull/merge request, DVC Studio automatically inserts a link to the training report. So your teammates who are reviewing your PR can quickly and easily compare your experiment with its baseline. @@ -82,12 +82,12 @@ quickly and easily compare your experiment with its baseline. ## CI-Based experiments -Iterative Studio can also use your regular CI/CD setup (e.g. GitHub Actions) to +DVC Studio can also use your regular CI/CD setup (e.g. GitHub Actions) to run the experiments. To enable this, do the following: 1. First, integrate your Git repository with a CI/CD setup that includes model training process. You can - [use the wizard provided by Iterative Studio](/doc/studio/user-guide/experiments/run-experiments#use-the-iterative-studio-wizard-to-set-up-your-ci-action) + [use the wizard provided by DVC Studio](/doc/studio/user-guide/experiments/run-experiments#use-the-iterative-studio-wizard-to-set-up-your-ci-action) to automatically generate the CI script, or you can write it on your own. 2. Then, @@ -96,11 +96,11 @@ run the experiments. To enable this, do the following: cloud provider. 3. Now, - [submit your experiments from Iterative Studio](#submit-a-new-experiment). + [submit your experiments from DVC Studio](#submit-a-new-experiment). Each submission will invoke your CI/CD setup, triggering the model training process. -### Use the Iterative Studio wizard to set up your CI action +### Use the DVC Studio wizard to set up your CI action Select a commit and click **Run**. You will see a message that invites you to set up your CI. @@ -134,7 +134,7 @@ This wizard has the following two sections, pre-filled with default values: | Parameter | Meaning | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | `Job script` | This is the script needed for your runner to execute your job, which would commonly include training your model. The default template is a very common combination of CML and DVC taking into account that DVC enables you to make the most of Iterative Studio. You can update this script to reflect your exact model training process, whether you use DVC or not. | + | `Job script` | This is the script needed for your runner to execute your job, which would commonly include training your model. The default template is a very common combination of CML and DVC taking into account that DVC enables you to make the most of DVC Studio. You can update this script to reflect your exact model training process, whether you use DVC or not. | - Right section which displays the generated yaml to be used in your CI set up. It reflects all your input parameters. Use the @@ -147,14 +147,14 @@ your experiments. Now, you can submit your experiments. ### Submit a new experiment Watch this video for an overview of how you can run CI-based experiments from -Iterative Studio. +DVC Studio. https://www.youtube.com/watch?v=nXJXR-zBvHQ -_Note that we have renamed DVC Studio mentioned in the above video to Iterative +_Note that we have renamed DVC Studio mentioned in the above video to DVC Studio and Views to Projects._ -To run experiments from Iterative Studio, determine the Git commit on which you +To run experiments from DVC Studio, determine the Git commit on which you want to iterate. Select the commit and click the `Run` button. A form opens, with 2 types of inputs that you can change: @@ -163,7 +163,7 @@ with 2 types of inputs that you can change: You can change datasets that are used for model training. The list of files that you can change will depend on your ML project. For instance, in the [`example-get-started` ML project][example-get-started project], an authorized -user can change the `data.xml` file. Iterative Studio identifies all the files +user can change the `data.xml` file. DVC Studio identifies all the files used in your ML project, which means that if you select the `Show all input parameters (including hidden)` option, then you can also change the hidden files such as the `model.pkl` model file and the `scores.json` @@ -172,7 +172,7 @@ wish to change the values of one or more hyperparameters. #### **Hyperparameters**: -Iterative Studio lists all the hyperparameters of your ML project and you can +DVC Studio lists all the hyperparameters of your ML project and you can change their values as per the new experiment that you want to run. For instance, in the [`example-get-started` ML project][example-get-started project], an authorized user can change @@ -210,7 +210,7 @@ Click on `Commit changes`. ### What happens after you submit a new CI-based experiment -**Git commit (and pull request) are created:** Iterative Studio will create a +**Git commit (and pull request) are created:** DVC Studio will create a Git commit with the changes you submitted. This commit appears in the project table. If you had specified a new branch to commit the changes to, then a new pull request will also be created from the new branch to the base branch. @@ -226,7 +226,7 @@ how to set up refer to [CML]. **Live metrics and plots are tracked:** In your model training CI action, you -can use [DVCLive] to send [live updates to metrics and plots] back to Iterative +can use [DVCLive] to send [live updates to metrics and plots] back to DVC Studio, without writing them to your Git repository. The live metrics are displayed alongside the corresponding experiment commits. diff --git a/content/docs/studio/user-guide/experiments/share-a-project.md b/content/docs/studio/user-guide/experiments/share-a-project.md index 4714267cb2..fa84283e8e 100644 --- a/content/docs/studio/user-guide/experiments/share-a-project.md +++ b/content/docs/studio/user-guide/experiments/share-a-project.md @@ -6,7 +6,7 @@ also [make a project public](#make-a-project-public) to share it on the web. ## Share a project within a team Each team that you -[create in Iterative Studio](/doc/studio/user-guide/team-collaboration) will +[create in DVC Studio](/doc/studio/user-guide/team-collaboration) will have its own projects dashboard. All the projects that you create in the team's dashboard will be accessible to all members (collaborators) of the team. @@ -38,7 +38,7 @@ repository is public, it will continue to remain public. Projects that are shared on the web can be opened by anyone, including people -who are not logged in to Iterative Studio. These anonymous users have the +who are not logged in to DVC Studio. These anonymous users have the `Visitor` role. Their access is limited to opening the project's experiment table, applying filters, and showing/hiding columns for themselves without saving any changes permanently. Refer to the diff --git a/content/docs/studio/user-guide/experiments/visualize-and-compare.md b/content/docs/studio/user-guide/experiments/visualize-and-compare.md index a0945bc061..7122f77d43 100644 --- a/content/docs/studio/user-guide/experiments/visualize-and-compare.md +++ b/content/docs/studio/user-guide/experiments/visualize-and-compare.md @@ -12,14 +12,14 @@ plot examples are AUC curves, loss functions, and confusion matrices. The easiest way to start is with [DVCLive], which will automatically generate plots data and configure them to be visualized. -Iterative Studio supports all [DVC plots], which can plot two types of files in +DVC Studio supports all [DVC plots], which can plot two types of files in your repository: 1. Data series files, which can be JSON, YAML, CSV or TSV. Data from these files will populate your AUC curves, loss functions, confusion matrices and other metric plots. 2. Image files in JPEG, GIF, or PNG format. These images will be displayed as-is - in Iterative Studio. + in DVC Studio. To open the `Plots` pane and display plots, select the plots toggle (highlighted in orange below) for one or more experiments and click on the `Plots` button diff --git a/content/docs/studio/user-guide/git-integrations/custom-gitlab-server.md b/content/docs/studio/user-guide/git-integrations/custom-gitlab-server.md index 50c45ad39a..c2eb3791a1 100644 --- a/content/docs/studio/user-guide/git-integrations/custom-gitlab-server.md +++ b/content/docs/studio/user-guide/git-integrations/custom-gitlab-server.md @@ -9,7 +9,7 @@ self-hosted GitLab servers. To connect to your self-hosted GitLab server, you will need the following: - A URL for your GitLab server. The URL should either be publicly accessible, or - in the same private network as Iterative Studio if Iterative Studio is + in the same private network as DVC Studio if DVC Studio is deployed on-premises. - A GitLab personal access token with the following roles: `api`, `read_user`, `read_repository`. If you do not have a personal access token yet, you can @@ -38,7 +38,7 @@ Connecting to a self-hosted GitLab server is different from connecting to your account on GitLab SaaS ([gitlab.com](http://gitlab.com/)). To connect to GitLab SaaS go to the `Git integrations` section in your [personal profile settings](https://studio.iterative.ai/user/_/profile). If you -signed up to use Iterative Studio using your GitLab account, you may already +signed up to use DVC Studio using your GitLab account, you may already have this connection. @@ -46,7 +46,7 @@ have this connection. Custom GitLab server support is available only within a team workspace, and is -available to all Iterative Studio teams (free and paid). +available to all DVC Studio teams (free and paid). diff --git a/content/docs/studio/user-guide/git-integrations/github-app.md b/content/docs/studio/user-guide/git-integrations/github-app.md index e75aeaade7..5492e3f093 100644 --- a/content/docs/studio/user-guide/git-integrations/github-app.md +++ b/content/docs/studio/user-guide/git-integrations/github-app.md @@ -1,9 +1,9 @@ -# Install the Iterative Studio GitHub App +# Install the DVC Studio GitHub App -If you are using a GitHub account, you can install the Iterative Studio app on +If you are using a GitHub account, you can install the DVC Studio app on the repositories or organizations that you want to use it with. -When you try to create a project, if the app is not already installed, Iterative +When you try to create a project, if the app is not already installed, DVC Studio will not be able to fetch the list of your GitHub repositories. In this case, you will be prompted to configure Git integrations as shown below. @@ -15,16 +15,16 @@ Click on the link to `Configure Git integrations settings`. This will open the ![](https://static.iterative.ai/img/studio/configure_github.png) Click on the `Configure` button, and you will be redirected to the GitHub page -to install and authorize the Iterative Studio GitHub app. +to install and authorize the DVC Studio GitHub app. ![](https://static.iterative.ai/img/studio/authorize_app_on_github_v2.png) You can specify the level of authorization that you want to grant: -- To authorize Iterative Studio on all the repositories in your GitHub account, +- To authorize DVC Studio on all the repositories in your GitHub account, select `All repositories`. - To limit access to only specific repositories, select `Only select repositories`. Then select the repositories which you want to use - with Iterative Studio. + with DVC Studio. Finally, click on `Install & Authorize`. diff --git a/content/docs/studio/user-guide/git-integrations/index.md b/content/docs/studio/user-guide/git-integrations/index.md index befdae2d40..39cea24737 100644 --- a/content/docs/studio/user-guide/git-integrations/index.md +++ b/content/docs/studio/user-guide/git-integrations/index.md @@ -1,13 +1,13 @@ # Git integrations -If you sign up to use Iterative Studio using your GitHub, GitLab or Bitbucket +If you sign up to use DVC Studio using your GitHub, GitLab or Bitbucket account, integration with that Git account gets created during sign up. If you sign in with your email address, you will need to [set up the Git integrations](/doc/studio/user-guide/account-and-billing#git-integrations). This is also needed if you want to connect to more than one Git provider. To **connect to your GitHub repositories**, you must -[install the Iterative Studio GitHub app](/doc/studio/user-guide/git-integrations/github-app). +[install the DVC Studio GitHub app](/doc/studio/user-guide/git-integrations/github-app). To **connect to a self-hosted GitLab server**, you should create a team and [set up the GitLab server connection](/doc/studio/user-guide/git-integrations/custom-gitlab-server). diff --git a/content/docs/studio/user-guide/model-registry/add-a-model.md b/content/docs/studio/user-guide/model-registry/add-a-model.md index a3d7da6db2..87f2b616d1 100644 --- a/content/docs/studio/user-guide/model-registry/add-a-model.md +++ b/content/docs/studio/user-guide/model-registry/add-a-model.md @@ -1,13 +1,13 @@ # Add a model You can add models from any ML project to the model registry. To add a model, -Iterative Studio creates an annotation for it in a `dvc.yaml` file in your Git +DVC Studio creates an annotation for it in a `dvc.yaml` file in your Git repository. You can add a model in any of the following ways: 1. Log your model during the training process using [dvclive] by calling [`live.log_artifact(path, type="model")`][log_artifact] method. 2. Edit `dvc.yaml` directly and add your model to [`artifacts`] section. -3. Use the Iterative Studio interface (watch this tutorial video or read on +3. Use the DVC Studio interface (watch this tutorial video or read on below). https://www.youtube.com/watch?v=szzv4ZXmYAs @@ -34,7 +34,7 @@ https://www.youtube.com/watch?v=szzv4ZXmYAs - If the model file is in the Git repository or is in the cloud but is tracked by DVC, enter the relative path of the model (from the repository root). - - Otherwise, enter the URL to the model file in the cloud. Iterative Studio + - Otherwise, enter the URL to the model file in the cloud. DVC Studio will ask you for the repository path where the dvc reference to the model should be saved. @@ -45,9 +45,9 @@ https://www.youtube.com/watch?v=szzv4ZXmYAs 6. Optionally, add a brief description for your model. 7. Enter a Git commit message. Then, select the branch to commit to. You can - commit to either the base branch or a new branch. Iterative Studio will + commit to either the base branch or a new branch. DVC Studio will commit the changes to the selected branch. If you commit to a new branch, - Iterative Studio will also create a Git pull request from the new branch to + DVC Studio will also create a Git pull request from the new branch to the base branch. 8. Now, click on `Commit changes`. @@ -62,11 +62,11 @@ have been created to merge the new branch into the base branch. If you had added a model from a cloud storage, the following will also happen before the commit is created: -- If the repository does not contain DVC, Iterative Studio will run `dvc init`. +- If the repository does not contain DVC, DVC Studio will run `dvc init`. It is needed to version the model in the git repository. [Learn more](/doc/command-reference/init). - If the specified directory does not exist yet, it will be created. -- Iterative Studio will import the model to the repository by executing +- DVC Studio will import the model to the repository by executing `dvc import-url / --no-exec`. [connected project]: /doc/studio/user-guide/experiments/create-a-project diff --git a/content/docs/studio/user-guide/model-registry/assign-stage.md b/content/docs/studio/user-guide/model-registry/assign-stage.md index ca7964dcf2..86ec2a8b33 100644 --- a/content/docs/studio/user-guide/model-registry/assign-stage.md +++ b/content/docs/studio/user-guide/model-registry/assign-stage.md @@ -3,7 +3,7 @@ To manage model lifecycle, you can assign stages (such as `dev`, `staging`, `prod`, etc.) to specific model versions. -To assign a stage to a model version, Iterative Studio uses [GTO] to create an +To assign a stage to a model version, DVC Studio uses [GTO] to create an annotated [Git tag][git tag] with the specified stage and version number. Refer to the [GTO docs][gto-format] to see the exact format of the Git tag. @@ -22,7 +22,7 @@ You can assign a stage in any of the following ways: [`gto assign cv:pool-segmentation --version v0.0.1 --stage dev`][assign] (here, `cv` is the parent directory). To get a better idea about this case, check out this [example monorepo][monorepo]. -2. To assign stages using Iterative Studio, watch this tutorial video or read on +2. To assign stages using DVC Studio, watch this tutorial video or read on below. https://www.youtube.com/watch?v=Vrp1O5lkWBo @@ -45,7 +45,7 @@ https://www.youtube.com/watch?v=Vrp1O5lkWBo - GTO config files with stage names are specific to a Git repository. So, they apply only to models within one repository. - - Currently, you cannot make entries to the GTO config file from Iterative + - Currently, you cannot make entries to the GTO config file from DVC Studio. - If you define stages in the config file at any point, any stage assignments after that point can use only the names defined in the config file. diff --git a/content/docs/studio/user-guide/model-registry/index.md b/content/docs/studio/user-guide/model-registry/index.md index d6d1b5d596..eed2c23553 100644 --- a/content/docs/studio/user-guide/model-registry/index.md +++ b/content/docs/studio/user-guide/model-registry/index.md @@ -1,6 +1,6 @@ # Model Registry -Iterative Studio Model Registry is a central registry of all your Machine +DVC Studio Model Registry is a central registry of all your Machine Learning models. It enables ML teams to collaborate on models by providing model organization, discovery, versioning, lineage (tracing the origin of the model) and the ability to manage production statuses (eg, `dev`, `shadow`, `prod`, diff --git a/content/docs/studio/user-guide/model-registry/register-version.md b/content/docs/studio/user-guide/model-registry/register-version.md index 11f4154b94..2446f13304 100644 --- a/content/docs/studio/user-guide/model-registry/register-version.md +++ b/content/docs/studio/user-guide/model-registry/register-version.md @@ -4,7 +4,7 @@ New model versions can signify an important, published or released iteration. To register version, you first need to [add a model to the model registry](/doc/studio/user-guide/model-registry/add-a-model). -To register a new version of a model, Iterative Studio uses [GTO] to create an +To register a new version of a model, DVC Studio uses [GTO] to create an annotated [Git tag][git tag] with the specified version number. Refer to the [GTO docs][gto-format] to see the exact format of the Git tag. @@ -22,7 +22,7 @@ You can register a version in any of the following ways: [`gto register cv:pool-segmentation --version v0.0.1`][register] (here, `cv` is the parent directory). To get a better idea about this case, check out this [example monorepo][monorepo]. -2. To register versions using Iterative Studio, watch this tutorial video or +2. To register versions using DVC Studio, watch this tutorial video or read on below. https://www.youtube.com/watch?v=eA70puzOp1o diff --git a/content/docs/studio/user-guide/model-registry/remove-a-model-or-its-details.md b/content/docs/studio/user-guide/model-registry/remove-a-model-or-its-details.md index f0cd378699..2c659c8b8e 100644 --- a/content/docs/studio/user-guide/model-registry/remove-a-model-or-its-details.md +++ b/content/docs/studio/user-guide/model-registry/remove-a-model-or-its-details.md @@ -1,7 +1,7 @@ # Remove a model, version, or stage assignment When you remove (deprecate) a model, deregister a version or unassign a stage, -Iterative Studio +DVC Studio [creates Git tags that indicate the action](/doc/gto/command-reference/deprecate) and saves the tags in your Git repository. @@ -32,7 +32,7 @@ These actions are also available in the model details page:

-To remove all of a project's models from Iterative Studio without deprecating them, you can simply delete the project. +To remove all of a project's models from DVC Studio without deprecating them, you can simply delete the project. diff --git a/content/docs/studio/user-guide/model-registry/use-models.md b/content/docs/studio/user-guide/model-registry/use-models.md index de446b9774..232c6cf159 100644 --- a/content/docs/studio/user-guide/model-registry/use-models.md +++ b/content/docs/studio/user-guide/model-registry/use-models.md @@ -1,7 +1,7 @@ # Use models Whether you need to download your models to use them, or you're looking to set -up some automation in CI/CD to deploy them, Iterative Studio provides these +up some automation in CI/CD to deploy them, DVC Studio provides these capabilities. ## Download models diff --git a/content/docs/studio/user-guide/model-registry/view-and-compare-models.md b/content/docs/studio/user-guide/model-registry/view-and-compare-models.md index 3f999bd307..3edb288b93 100644 --- a/content/docs/studio/user-guide/model-registry/view-and-compare-models.md +++ b/content/docs/studio/user-guide/model-registry/view-and-compare-models.md @@ -16,7 +16,7 @@ facilitates search and discovery. You can sort the models in the dashboard by several criteria, including model framework, repository, etc. -Iterative Studio consolidates the stages of all the models in the registry, and +DVC Studio consolidates the stages of all the models in the registry, and provides a way to filter models by stages. You can take a look at the [models dashboard] in Iterative's public (read only) @@ -38,7 +38,7 @@ A model details page is divided into the following sections: - a button to [register a new version](/doc/studio/user-guide/model-registry/register-version), and - - information about how many projects in Iterative Studio have been created + - information about how many projects in DVC Studio have been created from the model’s Git repository. - Left section: The left section contains information that is specific to a particular registered version of the model. It has a version picker, which you diff --git a/content/docs/studio/user-guide/team-collaboration/change-team-plan-and-size.md b/content/docs/studio/user-guide/team-collaboration/change-team-plan-and-size.md index f45d4bb988..c224db55a0 100644 --- a/content/docs/studio/user-guide/team-collaboration/change-team-plan-and-size.md +++ b/content/docs/studio/user-guide/team-collaboration/change-team-plan-and-size.md @@ -7,7 +7,7 @@ To change the plan for your team, go to the `Plan and billing` section within ![](https://static.iterative.ai/img/studio/team_settings_plan_and_billing_v2.png) -Click on `Change plan` (under `Current plan`). An Iterative Studio plan +Click on `Change plan` (under `Current plan`). An DVC Studio plan comparison page will open. Your current plan will be marked. ![](https://static.iterative.ai/img/studio/team_settings_plans_and_features_v2.png) @@ -21,7 +21,7 @@ You can upgrade to the Basic or Enterprise plan. **To upgrade to the Basic plan**, click on the `Upgrade` button. Then select the number of seats (collaborators) you need in your team. -![](https://static.iterative.ai/img/studio/team_settings_select_seats.png) +![](https://static.dvc.ai/img/studio/team_settings_select_seats.png) The total payable amount will be shown. See [Billing and Payment](/doc/studio/user-guide/account-and-billing/billing-and-payment) @@ -30,7 +30,7 @@ for details. Click on `Confirm` to provide payment and upgrade the plan. You will be redirected to our payment processor, [Stripe](https://stripe.com/). Once your payment is successful, you will be redirected back to the team settings page in -Iterative Studio. Here you can confirm your updated plan. +DVC Studio. Here you can confirm your updated plan. diff --git a/content/docs/studio/user-guide/team-collaboration/index.md b/content/docs/studio/user-guide/team-collaboration/index.md index 7e8f3ef4c3..9661e9339c 100644 --- a/content/docs/studio/user-guide/team-collaboration/index.md +++ b/content/docs/studio/user-guide/team-collaboration/index.md @@ -53,7 +53,7 @@ Team members or collaborators can have the following roles: - An additional role `Visitor` exists for anonymous users who can open a public project. -Iterative Studio does not have the concept of an `Owner` role. The user who +DVC Studio does not have the concept of an `Owner` role. The user who creates the team has the `Admin` role. The privileges of such an admin is the same as that of any other collaborator who has been assigned the `Admin` role. @@ -100,7 +100,7 @@ even if the project belongs to a team where you are an `Editor` or `Admin`. | Access a team's model details page | No | Yes | Yes | Yes | | Perform model actions in the team's model registry
- add / deprecate models
- register / deregsiter versions
- assign / unassign stages | No | Yes\* | Yes\* | Yes\* | -\*All team members can submit model actions in Iterative Studio. But for a team +\*All team members can submit model actions in DVC Studio. But for a team member's actions to successfully complete, the team member must have write access in the Git repository from where the model was added. This is because any model action constitutes writing a Git commit, pull/merge request or tag to the @@ -189,7 +189,7 @@ created teams are on the Free plan. This 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. A detailed comparison of the different plans can be -found in the Iterative Studio +found in the DVC Studio [pricing page](https://studio.iterative.ai/pricing). - **To upgrade** from the Free plan to the Basic or Enterprise plan or to diff --git a/content/docs/studio/user-guide/troubleshooting.md b/content/docs/studio/user-guide/troubleshooting.md index cec2ff52e3..b32a9411dd 100644 --- a/content/docs/studio/user-guide/troubleshooting.md +++ b/content/docs/studio/user-guide/troubleshooting.md @@ -1,12 +1,12 @@ # Troubleshooting Here we provide help for some of the problems that you may encounter when using -Iterative Studio. +DVC Studio. ## Support If you need further help, you can send us a message using `Help` on the -[Iterative Studio website](https://studio.iterative.ai). You can also +[DVC Studio website](https://studio.iterative.ai). You can also [email us](mailto:support@iterative.ai), create a support ticket on [GitHub](https://github.com/iterative/studio-support) or join the discussion in [Discord](https://discord.com/invite/dvwXA2N). @@ -45,7 +45,7 @@ If you need further help, you can send us a message using `Help` on the ## Errors accessing your Git repository -When Iterative Studio cannot access your Git repository, it can present one of +When DVC Studio cannot access your Git repository, it can present one of the following errors: - Repository not found or you don't have access to it @@ -59,11 +59,11 @@ the following errors: To fix this, make sure that the repository exists and you have access to it. Re-login to the correct Git account and try to import the repository again. If -you are connecting to a GitHub account, also make sure that the Iterative Studio +you are connecting to a GitHub account, also make sure that the DVC Studio GitHub app is installed. Additionally, network or third party issues (such as GitHub, GitLab or Bitbucket -outages) can also cause connection issues. In this case, Iterative Studio can +outages) can also cause connection issues. In this case, DVC Studio can display an appropriate indication in the error message. ## Errors related to parsing the repository @@ -77,7 +77,7 @@ import the repo again. ## Errors related to DVC remotes and credentials -Iterative Studio can include data from +DVC Studio can include data from [data remotes](/doc/studio/user-guide/experiments/configure-a-project#data-remotes-cloudremote-storage) in your project. However, it can access data from network-accessible remotes such as Amazon S3, Microsoft Azure, etc but not from [local DVC @@ -144,7 +144,7 @@ have selected the incorrect sub-directory. This could be a typical situation when your DVC repository is part of a [monorepo](https://en.wikipedia.org/wiki/Monorepo). Suppose your Git repository contains sub-directories A and B. If A contains the DVC repository which you -want to connect from Iterative Studio, but you specify B when creating the +want to connect from DVC Studio, but you specify B when creating the project, then you will get the above error. To solve this, you should [specify the full path to the correct @@ -162,7 +162,7 @@ to the correct sub-directory][project-settings] that contains the DVC repo. If you initialized a DVC repository, but did not push any commit with data, metrics or hyperparameters, then even though you will be able to connect to this -repository, the project will appear empty in Iterative Studio. To solve this, +repository, the project will appear empty in DVC Studio. To solve this, make relevant commits to your DVC repository. Refer to the [DVC documentation](https://dvc.org/doc) for help on making commits @@ -177,7 +177,7 @@ will still be able to work with your models in the model registry. There are two possible reasons for this: -1. **The required columns were not imported:** Iterative Studio will only import +1. **The required columns were not imported:** DVC Studio will only import columns that you select in the [**Columns** setting](/doc/studio/user-guide/experiments/configure-a-project#columns). @@ -186,18 +186,18 @@ There are two possible reasons for this: more than 500 columns), one solution is to split the metrics/hyperparameters/files that you want to display over multiple subdirectories in your Git repository. For each subdirectory, you - can create a new project in Iterative Studio and limit it to that + can create a new project in DVC Studio and limit it to that subdirectory. To create projects for subdirectories, [specify the project directory in project settings]. If this solution does not work for your use case, please create a support - ticket in the [Iterative Studio support GitHub repository]. + ticket in the [DVC Studio support GitHub repository]. [specify the project directory in project settings]: /doc/studio/user-guide/experiments/configure-a-project#project-directory -[iterative studio support github repository]: +[DVC studio support github repository]: https://github.com/iterative/studio-support 2. **The required columns are hidden:** In the project's experiment table, you @@ -212,7 +212,7 @@ There are two possible reasons for this: ## Project does not contain some of my commits or branches -This is likely not an error. Iterative Studio identifies commits that do not +This is likely not an error. DVC Studio identifies commits that do not change metrics, files or hyperparameters and will auto-hide such commits. It also auto-hides commits that contain the string `[skip studio]` in the commit message. You can also manually hide commits and branches, which means it is @@ -235,7 +235,7 @@ repository again. ## Error: Skipped big remote file(s) -Files that are larger than 10 MB are currently skipped by Iterative Studio. +Files that are larger than 10 MB are currently skipped by DVC Studio. ## Error: Base commit not found @@ -281,7 +281,7 @@ If you get this error and none of the above applies, please Confirm that you are correctly following the [procedure to send live metrics and plots](/doc/studio/user-guide/experiments/live-metrics-and-plots) -to Iterative Studio. +to DVC Studio. Note that a live experiment is nested under the parent Git commit in the project table. If the parent Git commit is not pushed to the Git repository, the live @@ -291,7 +291,7 @@ live experiment will get nested under the parent commit as expected. ## Project does not display DVC experiments -Iterative Studio automatically checks for updates to your repository using +DVC Studio automatically checks for updates to your repository using webhooks, but it can not rely on this mechanism for custom Git objects, like DVC experiment references. So the experiments you push using `dvc exp push` may not automatically display in your project table. @@ -312,20 +312,20 @@ issue for any future commits in your repository. ## Project does not reflect updates in the Git repository When there are updates (new commits, branches, etc.) in your Git repository, -your project in Iterative Studio gets reflected to include those updates. If the +your project in DVC Studio gets reflected to include those updates. If the project has stopped receiving updates from the Git repository and you have to `re-import` the project each time to get any new commit, then it is possible -that the Iterative Studio webhook in your repository got deleted or messed up. +that the DVC Studio webhook in your repository got deleted or messed up. -Iterative Studio periodically checks for any missing or messed up webhooks, and +DVC Studio periodically checks for any missing or messed up webhooks, and attempts to re-create them. Currently, this happens every 2 hours. The webhook also gets re-created every time you create a new project or re-import a repository. ## I cannot find my desired Git repository in the form to add a model -Only repositories that you have connected to Iterative Studio are available in -the `Add a model` form. To connect your desired repository to Iterative Studio, +Only repositories that you have connected to DVC Studio are available in +the `Add a model` form. To connect your desired repository to DVC Studio, go to the `Projects` tab and [create a project that connects to this Git repository][create a project]. Then you can come back to the model registry and add the model. @@ -333,14 +333,14 @@ add the model. ## Model registry does not display the models in my Git repositories For a model to be displayed in the model registry, it has to be registered using -[GTO]. You can [register the model] from Iterative Studio or with the [`gto` +[GTO]. You can [register the model] from DVC Studio or with the [`gto` CLI]. ## My models have disappeared even though I did not remove (deprecate) them When a project is deleted, all its models get automatically removed from the model registry. So check if the project has been removed. If yes, you can [add -the project][create a project] again. Deleting a project from Iterative Studio +the project][create a project] again. Deleting a project from DVC Studio does not delete any commits or tags from the Git repository. So, adding the project back will restore all the models from the repository along with their details, including versions and stage assignments. diff --git a/content/docs/user-guide/experiment-management/index.md b/content/docs/user-guide/experiment-management/index.md index 657eb4e680..5363ab4084 100644 --- a/content/docs/user-guide/experiment-management/index.md +++ b/content/docs/user-guide/experiment-management/index.md @@ -66,9 +66,9 @@ and declare metadata for the model registry in `dvc.yaml`. ## Work with DVC Experiments from a GUI DVC Experiments can be used directly [from the VS Code IDE] or online with -[Iterative Studio], the web UI that integrates all of our data science tools. +[DVC Studio], the web UI that integrates all of our data science tools. -### Iterative Studio +### DVC Studio https://www.youtube.com/watch?v=w-UjAbdpRY4 @@ -86,5 +86,5 @@ https://www.youtube.com/watch?v=LHi3SWGD9nc [plots]: /doc/user-guide/project-structure/dvcyaml-files#plots [visualize plots]: /doc/user-guide/experiment-management/visualizing-plots [from the vs code ide]: /doc/vs-code-extension -[iterative studio]: /doc/studio +[dvc studio]: /doc/studio [studio model registry]: /doc/studio/user-guide/model-registry diff --git a/content/docs/user-guide/project-structure/configuration.md b/content/docs/user-guide/project-structure/configuration.md index b01c07e19f..58a82d4d7d 100644 --- a/content/docs/user-guide/project-structure/configuration.md +++ b/content/docs/user-guide/project-structure/configuration.md @@ -66,7 +66,7 @@ within: - [`state`](#state) - see [Internal directories and files][internals] to learn more about the state database. - [`studio`](#studio) - options for configuring - [Iterative Studio](https://studio.iterative.ai/) token + [DVC Studio](https://studio.iterative.ai/) token - [`index`](#index) - see [Internal directories and files][internals] to learn more about remote index files.