From d1d8d7d0908e966fd11d3395cd8dd0c826d598d6 Mon Sep 17 00:00:00 2001 From: "Restyled.io" Date: Wed, 11 Oct 2023 08:30:35 +0000 Subject: [PATCH] Restyled by prettier --- content/docs/studio/experiments.md | 4 +- content/docs/studio/index.md | 10 +-- content/docs/studio/model-registry.md | 4 +- .../self-hosting/installation/aws-ami.md | 4 +- .../billing-and-payment.md | 14 ++-- .../user-guide/account-and-billing/index.md | 24 +++---- .../experiments/configure-a-project.md | 22 +++---- .../experiments/create-a-project.md | 8 +-- .../experiments/explore-ml-experiments.md | 36 +++++----- .../studio/user-guide/experiments/index.md | 14 ++-- .../experiments/live-metrics-and-plots.md | 44 ++++++------- .../user-guide/experiments/run-experiments.md | 66 +++++++++---------- .../user-guide/experiments/share-a-project.md | 14 ++-- .../experiments/visualize-and-compare.md | 4 +- .../git-integrations/custom-gitlab-server.md | 8 +-- .../user-guide/git-integrations/github-app.md | 8 +-- .../user-guide/git-integrations/index.md | 6 +- .../user-guide/model-registry/add-a-model.md | 20 +++--- .../user-guide/model-registry/assign-stage.md | 3 +- .../studio/user-guide/model-registry/index.md | 4 +- .../model-registry/register-version.md | 4 +- .../model-registry/view-and-compare-models.md | 4 +- .../change-team-plan-and-size.md | 4 +- .../user-guide/team-collaboration/index.md | 9 ++- .../docs/studio/user-guide/troubleshooting.md | 50 +++++++------- .../user-guide/experiment-management/index.md | 4 +- 26 files changed, 191 insertions(+), 201 deletions(-) diff --git a/content/docs/studio/experiments.md b/content/docs/studio/experiments.md index 791a44ee4e..687f16ffb6 100644 --- a/content/docs/studio/experiments.md +++ b/content/docs/studio/experiments.md @@ -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). diff --git a/content/docs/studio/index.md b/content/docs/studio/index.md index 5501147b79..453ff790c1 100644 --- a/content/docs/studio/index.md +++ b/content/docs/studio/index.md @@ -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) @@ -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. diff --git a/content/docs/studio/model-registry.md b/content/docs/studio/model-registry.md index 26d0b696c7..07e9f63ce4 100644 --- a/content/docs/studio/model-registry.md +++ b/content/docs/studio/model-registry.md @@ -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. diff --git a/content/docs/studio/self-hosting/installation/aws-ami.md b/content/docs/studio/self-hosting/installation/aws-ami.md index 98c2e5edf0..1158f3ddb3 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 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) 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 2d057655ec..ca46482d81 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 @@ -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 @@ -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 @@ -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. 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 9d7f610e11..54160fe177 100644 --- a/content/docs/studio/user-guide/account-and-billing/index.md +++ b/content/docs/studio/user-guide/account-and-billing/index.md @@ -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 @@ -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 @@ -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. @@ -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 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 693c8a869e..5358e37d31 100644 --- a/content/docs/studio/user-guide/experiments/configure-a-project.md +++ b/content/docs/studio/user-guide/experiments/configure-a-project.md @@ -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) @@ -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. @@ -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 @@ -107,11 +106,10 @@ 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. 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. 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 437aed01d2..7e115c1135 100644 --- a/content/docs/studio/user-guide/experiments/create-a-project.md +++ b/content/docs/studio/user-guide/experiments/create-a-project.md @@ -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. @@ -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 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 710c7b0371..de57df4702 100644 --- a/content/docs/studio/user-guide/experiments/explore-ml-experiments.md +++ b/content/docs/studio/user-guide/experiments/explore-ml-experiments.md @@ -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 @@ -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 @@ -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 @@ -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) diff --git a/content/docs/studio/user-guide/experiments/index.md b/content/docs/studio/user-guide/experiments/index.md index 4c9d80d3ac..573d23b1af 100644 --- a/content/docs/studio/user-guide/experiments/index.md +++ b/content/docs/studio/user-guide/experiments/index.md @@ -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 @@ -103,8 +103,8 @@ To set up, run and track dvc exp push origin ``` -- 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. @@ -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 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 38d87e6729..3b0fb3c913 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 @@ -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 @@ -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 @@ -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. @@ -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. - 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. -- **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. - 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. diff --git a/content/docs/studio/user-guide/experiments/run-experiments.md b/content/docs/studio/user-guide/experiments/run-experiments.md index e99f59096b..4610102618 100644 --- a/content/docs/studio/user-guide/experiments/run-experiments.md +++ b/content/docs/studio/user-guide/experiments/run-experiments.md @@ -59,11 +59,11 @@ Once you have added credentials, navigate to the project and follow these steps: ### Monitor a running experiment -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 -status and output log of the running experiment task. +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 status and +output log of the running experiment task. ![Studio View logs and live metrics of cloud experiments](/img/studio-cloud_exp_logs_and_live_metrics.gif) @@ -72,18 +72,18 @@ 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 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, 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. +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, 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. ![Studio Create a New Branch](/img/studio-branch.gif) ## CI-Based experiments -DVC Studio can also use your regular CI/CD setup (e.g. GitHub Actions) to -run the experiments. To enable this, do the following: +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 @@ -95,8 +95,7 @@ run the experiments. To enable this, do the following: This is needed so that your CI workflow can launch the runner in your desired cloud provider. -3. Now, - [submit your experiments from DVC Studio](#submit-a-new-experiment). +3. Now, [submit your experiments from DVC Studio](#submit-a-new-experiment). Each submission will invoke your CI/CD setup, triggering the model training process. @@ -132,8 +131,8 @@ This wizard has the following two sections, pre-filled with default values: 2. Job script, which is used in the `runner-job` step of your CI workflow - | Parameter | Meaning | - | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | 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 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. @@ -151,20 +150,20 @@ DVC Studio. https://www.youtube.com/watch?v=nXJXR-zBvHQ -_Note that we have renamed DVC Studio mentioned in the above video to DVC -Studio and Views to Projects._ +_Note that we have renamed DVC Studio mentioned in the above video to DVC Studio +and Views to Projects._ -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: +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: #### **Input data files**: 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. DVC Studio identifies all the files -used in your ML project, which means that if you select the +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` metrics file. You can also choose not to change any input data files if you only @@ -172,13 +171,12 @@ wish to change the values of one or more hyperparameters. #### **Hyperparameters**: -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 -`max_features` (the maximum number of features that the model uses), `ngrams`, -etc. You can also choose not to change any hyperparameters if you only wish to -change one or more input data files. +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 `max_features` (the maximum number of features that +the model uses), `ngrams`, etc. You can also choose not to change any +hyperparameters if you only wish to change one or more input data files. The default values of the input data files and hyperparameters in this form are extracted from your selected commit. @@ -210,10 +208,10 @@ Click on `Commit changes`. ### What happens after you submit a new CI-based experiment -**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. +**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. **Model training is invoked:** If your ML project is integrated with a CI/CD setup (e.g. GitHub Actions), the CI/CD setup will get invoked. If this setup 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 fa84283e8e..9a28965ba0 100644 --- a/content/docs/studio/user-guide/experiments/share-a-project.md +++ b/content/docs/studio/user-guide/experiments/share-a-project.md @@ -6,9 +6,9 @@ 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 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. +[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. To add more than 2 collaborators in your team, [upgrade to the **Basic** or **Enterprise** plan](/doc/studio/user-guide/change-team-plan-and-size). @@ -38,9 +38,9 @@ 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 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 +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 [Roles](/doc/studio/user-guide/team-collaboration#roles) section for details on the features available for different roles. 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 7122f77d43..a68d939894 100644 --- a/content/docs/studio/user-guide/experiments/visualize-and-compare.md +++ b/content/docs/studio/user-guide/experiments/visualize-and-compare.md @@ -12,8 +12,8 @@ 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. -DVC Studio supports all [DVC plots], which can plot two types of files in -your repository: +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 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 c2eb3791a1..70c58e3f4e 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,8 +9,8 @@ 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 DVC Studio if DVC Studio is - deployed on-premises. + 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 create one at @@ -38,8 +38,8 @@ 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 DVC Studio using your GitLab account, you may already -have this connection. +signed up to use DVC Studio using your GitLab account, you may already have this +connection. 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 5492e3f093..83ecdec40d 100644 --- a/content/docs/studio/user-guide/git-integrations/github-app.md +++ b/content/docs/studio/user-guide/git-integrations/github-app.md @@ -1,7 +1,7 @@ # Install the DVC Studio GitHub App -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. +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, DVC Studio will not be able to fetch the list of your GitHub repositories. In this @@ -21,8 +21,8 @@ to install and authorize the DVC Studio GitHub app. You can specify the level of authorization that you want to grant: -- To authorize DVC Studio on all the repositories in your GitHub account, - select `All repositories`. +- 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 DVC Studio. diff --git a/content/docs/studio/user-guide/git-integrations/index.md b/content/docs/studio/user-guide/git-integrations/index.md index 39cea24737..d99d373945 100644 --- a/content/docs/studio/user-guide/git-integrations/index.md +++ b/content/docs/studio/user-guide/git-integrations/index.md @@ -1,8 +1,8 @@ # Git integrations -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 +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. 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 87f2b616d1..1677a8d5a3 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 @@ -7,8 +7,7 @@ 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 DVC Studio interface (watch this tutorial video or read on - below). +3. Use the DVC Studio interface (watch this tutorial video or read on below). https://www.youtube.com/watch?v=szzv4ZXmYAs @@ -34,9 +33,9 @@ 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. DVC Studio - will ask you for the repository path where the dvc reference to the model - should be saved. + - 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. 5. Provide labels for your model. For example, if your model is about reviewing sentiment analysis using natural language processing, one of the labels may @@ -45,10 +44,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. DVC Studio will - commit the changes to the selected branch. If you commit to a new branch, - DVC Studio will also create a Git pull request from the new branch to - the base branch. + 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, DVC Studio + will also create a Git pull request from the new branch to the base branch. 8. Now, click on `Commit changes`. @@ -62,8 +60,8 @@ 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, DVC Studio will run `dvc init`. - It is needed to version the model in the git repository. +- 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. - DVC Studio will import the model to the repository by executing 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 86ec2a8b33..a226bf90bf 100644 --- a/content/docs/studio/user-guide/model-registry/assign-stage.md +++ b/content/docs/studio/user-guide/model-registry/assign-stage.md @@ -45,8 +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 DVC - Studio. + - 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 eed2c23553..fa7bdefc96 100644 --- a/content/docs/studio/user-guide/model-registry/index.md +++ b/content/docs/studio/user-guide/model-registry/index.md @@ -1,7 +1,7 @@ # Model Registry -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 +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`, etc.) of your models on top of Git. 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 2446f13304..0af05a52a7 100644 --- a/content/docs/studio/user-guide/model-registry/register-version.md +++ b/content/docs/studio/user-guide/model-registry/register-version.md @@ -22,8 +22,8 @@ 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 DVC Studio, watch this tutorial video or - read on below. +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/view-and-compare-models.md b/content/docs/studio/user-guide/model-registry/view-and-compare-models.md index 3edb288b93..0755ad7b5f 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 @@ -38,8 +38,8 @@ 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 DVC Studio have been created - from the model’s Git repository. + - 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 can use to switch between different registered versions of the model. For the 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 c224db55a0..3376accfd9 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,8 +7,8 @@ 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 DVC Studio plan -comparison page will open. Your current plan will be marked. +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) diff --git a/content/docs/studio/user-guide/team-collaboration/index.md b/content/docs/studio/user-guide/team-collaboration/index.md index 9661e9339c..2784c07c0a 100644 --- a/content/docs/studio/user-guide/team-collaboration/index.md +++ b/content/docs/studio/user-guide/team-collaboration/index.md @@ -53,9 +53,9 @@ Team members or collaborators can have the following roles: - An additional role `Visitor` exists for anonymous users who can open a public project. -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. +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. @@ -189,8 +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 DVC Studio -[pricing page](https://studio.iterative.ai/pricing). +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 downgrade your team plan, refer to the section on [changing your team plan]. diff --git a/content/docs/studio/user-guide/troubleshooting.md b/content/docs/studio/user-guide/troubleshooting.md index b32a9411dd..3d72b51a13 100644 --- a/content/docs/studio/user-guide/troubleshooting.md +++ b/content/docs/studio/user-guide/troubleshooting.md @@ -45,8 +45,8 @@ If you need further help, you can send us a message using `Help` on the ## Errors accessing your Git repository -When DVC Studio cannot access your Git repository, it can present one of -the following errors: +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 - Unable to access repository due to stale authorization @@ -63,8 +63,8 @@ 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, DVC Studio can -display an appropriate indication in the error message. +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 @@ -144,8 +144,8 @@ 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 DVC Studio, but you specify B when creating the -project, then you will get the above error. +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 sub-directory][project-settings] that contains the DVC repo. @@ -162,8 +162,8 @@ 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 DVC Studio. To solve this, -make relevant commits to your DVC repository. +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 to a DVC repository. @@ -186,8 +186,7 @@ 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 DVC Studio and limit it to that - subdirectory. + 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]. @@ -212,9 +211,9 @@ There are two possible reasons for this: ## Project does not contain some of my commits or branches -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 +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 possible that the commits or branches you do not see in your project were manually hidden by you or someone else in your team. @@ -291,10 +290,10 @@ live experiment will get nested under the parent commit as expected. ## Project does not display DVC experiments -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. +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. To manually check for updates in your repository, use the `Reload` button 🔄 located above the project table. @@ -324,26 +323,25 @@ repository. ## I cannot find my desired Git repository in the form to add a model -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 +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. ## 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 DVC Studio or with the [`gto` -CLI]. +[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 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. +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. ## Questions or problems with billing and payment diff --git a/content/docs/user-guide/experiment-management/index.md b/content/docs/user-guide/experiment-management/index.md index 5363ab4084..80e5f8b8b3 100644 --- a/content/docs/user-guide/experiment-management/index.md +++ b/content/docs/user-guide/experiment-management/index.md @@ -65,8 +65,8 @@ 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 -[DVC Studio], the web UI that integrates all of our data science tools. +DVC Experiments can be used directly [from the VS Code IDE] or online with [DVC +Studio], the web UI that integrates all of our data science tools. ### DVC Studio