Skip to content

Commit

Permalink
Remove run experiment sections of Studio docs (#4996)
Browse files Browse the repository at this point in the history
* Remove run experiment sections of Studio docs

* Remove run exp from some more docs pages and sections (#4997)

* Remove 'Running the pipline(s) on the cloud' section

* Rename header

---------

Co-authored-by: tapadipti <[email protected]>
  • Loading branch information
jellebouwman and tapadipti authored Nov 21, 2023
1 parent 2011728 commit f6da4fe
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 420 deletions.
4 changes: 1 addition & 3 deletions content/docs/studio/experiments.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,7 @@ experiments with DVC Studio:
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 the VS Code IDE.

For details on all these, check out the
[`experiment management user guide`](/doc/studio/user-guide/experiments).
Expand Down
2 changes: 0 additions & 2 deletions content/docs/studio/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ https://www.youtube.com/watch?v=w-UjAbdpRY4
Git.
- Keep your code, data and model connected at all times.
- Apply your existing software engineering stack for ML teams.
- Automate your ML process by transitioning to a no-code interface for running
experiments on cloud resources of your choice.
- Build an ML model registry for transparency and discovery across all your
projects.
- Because your model registry is built on top of Git, you can use
Expand Down
124 changes: 3 additions & 121 deletions content/docs/studio/user-guide/account-and-billing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,133 +68,15 @@ handy if you suspect that your account security may have been compromised.
### Cloud credentials

In the `Cloud Credentials` section of your [Profile] page, you can view, add and
update credentials for cloud resources. These credentials are used to:

- [fetch project data from data remotes](/doc/studio/user-guide/experiments/configure-a-project#data-remotes--cloud-storage-credentials),
and
- [create cloud resources for running experiments](/doc/studio/user-guide/experiments/run-experiments#cloud-experiments).
update credentials for cloud resources. These credentials are used to
[fetch project data from data remotes](/doc/studio/user-guide/experiments/configure-a-project#data-remotes--cloud-storage-credentials).

To add new credentials, click `Add credentials` and select the cloud provider.
Depending on the provider, you will be asked for more details. Note that
[cloud experiments](/doc/studio/user-guide/experiments/run-experiments#cloud-experiments)
currently support AWS and GCP.
Depending on the provider, you will be asked for more details.

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

The credentials must have the required permissions. For
[cloud experiments](/doc/studio/user-guide/experiments/run-experiments#cloud-experiments),
the following permissions are needed:

<details>

#### AWS

```
"autoscaling:CreateAutoScalingGroup",
"autoscaling:DeleteAutoScalingGroup",
"autoscaling:DescribeAutoScalingGroups",
"autoscaling:DescribeScalingActivities",
"autoscaling:UpdateAutoScalingGroup",
"ec2:AuthorizeSecurityGroupEgress",
"ec2:AuthorizeSecurityGroupIngress",
"ec2:CancelSpotInstanceRequests",
"ec2:CreateKeyPair",
"ec2:CreateLaunchTemplate",
"ec2:CreateSecurityGroup",
"ec2:CreateTags",
"ec2:DeleteKeyPair",
"ec2:DeleteLaunchTemplate",
"ec2:DeleteSecurityGroup",
"ec2:DescribeAutoScalingGroups",
"ec2:DescribeImages",
"ec2:DescribeInstanceTypeOfferings",
"ec2:DescribeInstances",
"ec2:DescribeKeyPairs",
"ec2:DescribeLaunchTemplates",
"ec2:DescribeScalingActivities",
"ec2:DescribeSecurityGroups",
"ec2:DescribeSpotInstanceRequests",
"ec2:DescribeSubnets",
"ec2:DescribeVpcs",
"ec2:GetLaunchTemplateData",
"ec2:ImportKeyPair",
"ec2:ModifyImageAttribute",
"ec2:ModifyLaunchTemplate",
"ec2:RequestSpotInstances",
"ec2:RevokeSecurityGroupEgress",
"ec2:RevokeSecurityGroupIngress",
"ec2:RunInstances",
"ec2:TerminateInstances",
"s3:CreateBucket",
"s3:DeleteBucket",
"s3:DeleteObject",
"s3:GetObject",
"s3:ListBucket",
"s3:PutObject",
```

See
https://github.com/iterative/terraform-provider-iterative/blob/a92499539f109821c021d1efb1fb01e51f1db47f/docs/guides/permissions/aws/main.tf

</details>

<details>

#### GCP

```
"compute.acceleratorTypes.get",
"compute.diskTypes.get",
"compute.disks.create",
"compute.firewalls.create",
"compute.firewalls.delete",
"compute.firewalls.get",
"compute.globalOperations.get",
"compute.instanceGroupManagers.create",
"compute.instanceGroupManagers.delete",
"compute.instanceGroupManagers.get",
"compute.instanceGroupManagers.update",
"compute.instanceGroups.create",
"compute.instanceGroups.delete",
"compute.instanceGroups.get",
"compute.instanceTemplates.create",
"compute.instanceTemplates.delete",
"compute.instanceTemplates.get",
"compute.instanceTemplates.useReadOnly",
"compute.instances.create",
"compute.instances.delete",
"compute.instances.get",
"compute.instances.setMetadata",
"compute.instances.setServiceAccount",
"compute.instances.setTags",
"compute.machineTypes.get",
"compute.networks.create",
"compute.networks.get",
"compute.networks.updatePolicy",
"compute.subnetworks.use",
"compute.subnetworks.useExternalIp",
"compute.zoneOperations.get",
"iam.serviceAccounts.actAs",
"storage.buckets.create",
"storage.buckets.delete",
"storage.buckets.get",
"storage.multipartUploads.abort",
"storage.multipartUploads.create",
"storage.multipartUploads.list",
"storage.multipartUploads.listParts",
"storage.objects.create",
"storage.objects.delete",
"storage.objects.get",
"storage.objects.list",
"storage.objects.update",
```

See
https://github.com/iterative/terraform-provider-iterative/blob/a92499539f109821c021d1efb1fb01e51f1db47f/docs/guides/permissions/gcp/main.tf

</details>

For
[data remotes](/doc/studio/user-guide/experiments/configure-a-project#data-remotes--cloud-storage-credentials),
you can find more details about required permissions [here][data remote].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ project name to open the project table, which contains:
project
- [Display preferences](#display-preferences)
- Buttons to
[visualize, compare, and run experiments](#visualize-compare-and-run-experiments).
[visualize and compare experiments](#visualize-and-compare-experiments).
- Button to [export project data](#export-project-data).

## Git history and live experiments
Expand Down Expand Up @@ -211,16 +211,14 @@ and log back in later.

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

## Visualize, compare and run experiments
## Visualize and compare experiments

Use the following buttons to visualize, compare and run experiments:
Use the following buttons to visualize and compare experiments:

- **Plots:** Open the `Plots` pane and [display plots] for the selected commits.
- **Trends:** [Generate trend charts] to see how the metrics have changed over
time.
- **Compare:** [Compare experiments] side by side.
- **Run:** [Run experiments] and [track results in real
time][live-metrics-and-plots].

These buttons appear above your project table as shown below.
![example export to csv](https://static.iterative.ai/img/studio/project_action_buttons_big_screen.png)
Expand All @@ -246,7 +244,6 @@ Below is an example of the downloaded CSV file.
/doc/studio/user-guide/experiments/visualize-and-compare#display-plots-and-images
[Compare experiments]:
/doc/studio/user-guide/experiments/visualize-and-compare#compare-experiments
[run experiments]: /doc/studio/user-guide/experiments/run-experiments
[live-metrics-and-plots]:
/doc/studio/user-guide/experiments/live-metrics-and-plots
[Generate trend charts]:
Expand Down
6 changes: 1 addition & 5 deletions content/docs/studio/user-guide/experiments/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

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 DVC Studio][run-experiments].
the Python cli, the bash terminal, etc.

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.
Expand Down Expand Up @@ -121,8 +120,6 @@ Within a project, you can:
have pushed to your Git repository.
- [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 DVC Studio.
- [Track live metrics and plots][live-metrics-and-plots] by sending them to DVC
Studio by using [DVCLive].

Expand All @@ -131,7 +128,6 @@ Within a project, you can:
[visualize]: /doc/studio/user-guide/experiments/visualize-and-compare
[compare]:
/doc/studio/user-guide/experiments/visualize-and-compare#compare-experiments
[run-experiments]: /doc/studio/user-guide/experiments/run-experiments
[live-metrics-and-plots]:
/doc/studio/user-guide/experiments/live-metrics-and-plots
[dvclive]: /doc/dvclive
Loading

0 comments on commit f6da4fe

Please sign in to comment.