Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nav: clean up Studio nav + misc. updates #3621

Merged
merged 25 commits into from
Jul 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
2804073
nav: clean up and rename files + remove UG index
jorgeorpinel Jun 4, 2022
f2632bc
studio: misc. edits
jorgeorpinel Jun 4, 2022
983beaa
studio: redirects per sidebar changes
jorgeorpinel Jun 5, 2022
b38a94f
nav: viz exps (Studio UG)
jorgeorpinel Jun 5, 2022
c997215
links: changes studio URLs
jorgeorpinel Jun 5, 2022
6523ebf
studio: remove how-it-works info from overview
jorgeorpinel Jun 5, 2022
f7cb138
Merge branch 'master' into nav/studio
jorgeorpinel Jun 7, 2022
87cb4c5
Merge branch 'main' into nav/studio and
jorgeorpinel Jul 18, 2022
8eea458
Update content/docs/studio/user-guide/prepare-your-repositories.md
jorgeorpinel Jul 18, 2022
ac16eea
Update content/docs/studio/get-started.md
jorgeorpinel Jul 18, 2022
6da2aaf
Update content/docs/studio/get-started.md
jorgeorpinel Jul 18, 2022
e58b61d
guide: better md ref link
jorgeorpinel Jul 18, 2022
184fe6a
Restyled by prettier (#3775)
restyled-io[bot] Jul 18, 2022
7ce6eca
guide: better titles for Change Team Plan and Size
jorgeorpinel Jul 18, 2022
16d2db9
Merge branch 'nav/studio' of github.com:iterative/dvc.org into nav/st…
jorgeorpinel Jul 18, 2022
fad68e8
guide: GH App title
jorgeorpinel Jul 18, 2022
2a60ad1
guide: Connect GL Server title
jorgeorpinel Jul 18, 2022
3d08d3e
Update content/docs/studio/user-guide/billing-and-payment.md
jorgeorpinel Jul 18, 2022
a6c78b6
Restyled by prettier (#3777)
restyled-io[bot] Jul 18, 2022
9469e30
Merge branch 'main' into nav/studio
jorgeorpinel Jul 19, 2022
2f35edf
Resolved merge conflict
tapadipti Jul 25, 2022
0b55051
Apply suggestions from code review
jorgeorpinel Jul 25, 2022
c1cf02c
Restyled by prettier (#3803)
restyled-io[bot] Jul 25, 2022
6a2f562
Update redirects-list.json
jorgeorpinel Jul 25, 2022
822b66b
Update redirects-list.json
jorgeorpinel Jul 25, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 9 additions & 28 deletions content/docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -521,46 +521,27 @@
"icon": "vscode"
},
{
"label": "Studio",
"slug": "studio",
"source": "studio/index.md",
"icon": "studio",
"children": [
{
"label": "How It Works",
"slug": "overview"
},
"how-it-works",
tapadipti marked this conversation as resolved.
Show resolved Hide resolved
"get-started",
{
"label": "User Guide",
"slug": "user-guide",
"source": "user-guide/index.md",
"source": false,
tapadipti marked this conversation as resolved.
Show resolved Hide resolved
"children": [
"prepare-your-repositories",
{
"label": "Prepare Your Repositories",
"slug": "prepare-repositories"
},
{
"label": "Projects and Experiments",
"slug": "projects",
"slug": "projects-and-experiments",
"source": false,
"children": [
"what-is-a-project",
"create-project",
{
"label": "Configure Project",
"slug": "project-settings"
},
{
"label": "Explore ML Experiments",
"slug": "explore-experiments"
},
{
"label": "Visualize and Compare",
"slug": "visualize-experiments"
},
"create-a-project",
"configure-a-project",
"explore-ml-experiments",
"visualize-and-compare",
"run-experiments",
"share-project"
"share-a-project"
]
},
"teams",
Expand Down
34 changes: 21 additions & 13 deletions content/docs/studio/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,9 @@ more projects._
> Project settings must be configured if you are connecting to a non-DVC
> repository, if your metrics are in some custom files, if you are connecting to
> a monorepo, or if your metrics are in cloud or other remote storage. However,
> you can configure the project settings after the project has been created. So,
> you can configure the project settings after the project has been created. So
> you can `Skip and Continue` now. Refer to the [Project Settings] section for
> more details.
>
> [project settings]: /doc/studio/user-guide/projects/project-settings

You should now see that a project has been added in your dashboard.

Expand All @@ -91,17 +89,27 @@ You should now see that a project has been added in your dashboard.

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

8. You can also
[create multiple projects from a single Git repository](/doc/studio/user-guide/projects/create-project#create-multiple-projects-from-a-single-git-repository).
8. You can also [create multiple projects from a single Git repository].

9. After creating a project, you can use it to
[explore the ML experiments](/doc/studio/user-guide/explore-experiments) as
well as
[submit new experiments from Iterative Studio](/doc/studio/user-guide/run-experiments).
9. After creating a project, you can use it to [explore the ML experiments] as
well as [submit new experiments] from Iterative Studio.

10. You can also make the project public by
[sharing it on the web](/doc/studio/user-guide/projects/share-project).
10. You can also make the project public by [sharing it on the web].

11. You can [create a team] and invite collaborators. Each team will have its
own projects dashboard. To create teams with more than 2 team members,
[upgrade into the **Team** or **Enterprise** plan](/doc/studio/user-guide/change-team-plan-and-size).
own projects dashboard. To create teams with more than 2 team members, [sign
up for the **Team** plan or **Enterprise** plan].

[project settings]:
/doc/studio/user-guide/projects-and-experiments/configure-a-project
[create multiple projects from a single git repository]:
/doc/studio/user-guide/projects-and-experiments/create-a-project#create-multiple-projects-from-a-single-git-repository
[explore the ml experiments]:
/doc/studio/user-guide/projects-and-experiments/explore-ml-experiments
[submit new experiments]:
/doc/studio/user-guide/projects-and-experiments/run-experiments
[sharing it on the web]:
/doc/studio/user-guide/projects-and-experiments/share-a-project
[create a team]: /doc/studio/user-guide/teams
[sign up for the **team** plan or **enterprise** plan]:
/doc/studio/user-guide/change-team-plan-and-size
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How Iterative Studio Works

[`Iterative Studio`](https://studio.iterative.ai/) works with the data, metrics
[Iterative Studio](https://studio.iterative.ai/) works with the data, metrics
and hyperparameters that you add to your ML project Git repositories. It works
very closely with your Git ecosystem. Using DVC and Git, you will push all your
ML experiments to your GitHub, GitLab or Bitbucket repositories as Git commits.
Expand Down
14 changes: 7 additions & 7 deletions content/docs/studio/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Iterative Studio

[`Iterative Studio`](https://studio.iterative.ai/) is a web application that you
can [access online](https://studio.iterative.ai/) or even host on-prem. It works
with the data, metrics and hyperparameters that you add to your ML project
repositories. Using the power of leading open-source tools DVC,
[CML](https://cml.dev) and Git, it enables you to seamlessly manage data and
models, run and track experiments, and visualize and share results.
[Iterative Studio](https://studio.iterative.ai/) is a web application that you
can access online or even host on-prem. It works with the data, metrics, and
hyperparameters that you add to your ML project repositories. Using the power of
leading open-source tools DVC, [CML](https://cml.dev), and Git, it enables you
to seamlessly manage data and models, run and track experiments, and visualize
and share results.

<cards>

<card href="/doc/studio/overview" heading="How Iterative Studio works">
<card href="/doc/studio/how-it-works" heading="How Iterative Studio works">
Learn how Iterative Studio works closely with the Git ecosystem
</card>

Expand Down
49 changes: 30 additions & 19 deletions content/docs/studio/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,14 @@ files that contain the metrics and hyperparameters that you want to visualize.
Otherwise, you will get this message when you try to add a project:
`We could not find data to visualize in this repo`.

For more details, refer to the section on
[how to prepare your Git repositories for use with Iterative Studio](/doc/studio/user-guide/prepare-repositories).
Instructions on how to specify custom files can be found
[here](/doc/studio/user-guide/projects/project-settings#configuring-project-settings).
For more details, refer to the section on how to [prepare your Git repositories]
for use with Iterative Studio. Instructions on how to specify custom files can
be found [here][project-settings].

[prepare your git repositories]:
/doc/studio/user-guide/prepare-your-repositories
[project-settings]:
/doc/studio/user-guide/projects-and-experiments/configure-a-project#configuring-project-settings

## Error: No DVC repo was found at the root

Expand All @@ -60,7 +64,7 @@ To solve this, you can either:
want to visualize.

Instructions on how to specify the sub-directory or custom files can be found
[here](/doc/studio/user-guide/projects/project-settings#configuring-project-settings).
[here][project-settings].

## Error: Non-DVC sub-directory of a monorepo

Expand All @@ -83,7 +87,7 @@ To solve this, you can either:
want to visualize.

Instructions on how to specify the sub-directory or custom files can be found
[here](/doc/studio/user-guide/projects/project-settings#configuring-project-settings).
[here][project-settings].

## Error: No commits were found for the sub-directory

Expand All @@ -98,7 +102,7 @@ If you did not intend to work with a DVC repo, you can also specify custom files
that contain the metrics and hyperparameters that you want to visualize.

Instructions on how to specify the sub-directory or custom files can be found
[here](/doc/studio/user-guide/projects/project-settings#configuring-project-settings).
[here][project-settings].

## Project got created, but does not contain any data

Expand All @@ -110,18 +114,17 @@ with the metrics or hyperparameters that you want to visualize.

Refer to the [DVC documentation](https://dvc.org/doc) for help on making commits
to a DVC repository. Instructions on how to specify custom files can be found
[here](/doc/studio/user-guide/projects/project-settings#configuring-project-settings).
[here][project-settings].

## Project does not contain the columns that I want

There are two possible reasons for this:

1. **The required columns were not imported:** Iterative Studio will import up
to 200 columns (metrics, hyperparameters and files) from your Git repository.
If your repository has more than 200 columns, you should
[select the columns that are mandatory to import](/doc/studio/user-guide/projects/project-settings#mandatory-columns).
Iterative Studio will also import the unselected columns, but only up to a
maximum of 200 columns.
If your repository has more than 200 columns, you should [select the columns
that are mandatory to import]. Iterative Studio will also import the
unselected columns, but only up to a maximum of 200 columns.

**What if there are more than 200 mandatory columns?** Currently Iterative
Studio cannot import over 200 columns. If you have a large repository (with
Expand All @@ -131,12 +134,18 @@ There are two possible reasons for this:
can create a new project in Iterative Studio and limit it to that
subdirectory.

To create projects for subdirectories,
[specify the project directory in project settings](/doc/studio/user-guide/projects/project-settings#project-directory).
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](https://github.com/iterative/studio-support).
ticket in the [Iterative Studio support GitHub repository].

[select the columns that are mandatory to import]:
/doc/studio/user-guide/projects-and-experiments/configure-a-project#mandatory-columns
[specify the project directory in project settings]:
/doc/studio/user-guide/projects-and-experiments/configure-a-project#project-directory
[iterative studio support github repository]:
https://github.com/iterative/studio-support

2. **The required columns are hidden:** In the project's experiment table, you
can hide the columns that you do not want to display. If any column that you
Expand Down Expand Up @@ -170,9 +179,11 @@ or branches you do not see in your project were manually hidden by you or
someone else in your team.

You can unhide commits and branches to display them. For details, refer to
[Display preferences -> Hide commits](/doc/studio/user-guide/projects/explore-experiments#hide-commits).
However, if the missing commit/branch is not in the hidden commits list, then
please [raise a support request](#support).
Display preferences -> [Hide commits]. However, if the missing commit/branch is
not in the hidden commits list, then please [raise a support request](#support).

[hide commits]:
/doc/studio/user-guide/projects-and-experiments/explore-ml-experiments#hide-commits

## Error: Failed to push experiment to repository

Expand Down
21 changes: 4 additions & 17 deletions content/docs/studio/user-guide/change-team-plan-and-size.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,6 @@
# Change Team Plan and Size

When you sign up, you're on the **Free plan**. This plan is 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 Team or Enterprise plans.
A detailed comparison of the different plans can be found in the Iterative
Studio [pricing page](https://studio.iterative.ai/pricing).

In this page, you learn how to:

- [Change your team plan](#change-your-team-plan)
- [Change your team size](#change-your-team-size)

## Change your team plan
## Change the plan your Team is on

To change the plan for your team, go to the `Plan and billing` section within
[team settings]. Then click on `Change plan` (under `Current plan`).
Expand Down Expand Up @@ -80,15 +67,15 @@ needs and suggest a suitable plan and pricing.

For any changes to the plan, please contact your focal point at Iterative.

## Change your team size
## Change the size of your Team

You can change the size of your team within the Team or Enterprise plans at any
point.

### If you are on the Free plan

To change the number of seats in your team beyond 2,
[upgrade to the Team or Enterprise plans](#change-your-team-plan).
To change the number of seats in your team,
[upgrade to the Team or Enterprise plan](#change-the-plan-your-team-is-on).

### If you are on the Team plan

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Custom GitLab Server Connection
# Connect a Custom GitLab Server

If your team’s Git repositories are on a self-hosted GitLab server, you can set
up a connection to this server such that all your team members can connect to
Expand Down
19 changes: 0 additions & 19 deletions content/docs/studio/user-guide/index.md

This file was deleted.

16 changes: 8 additions & 8 deletions content/docs/studio/user-guide/install-github-app.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Iterative Studio GitHub App Installation

If you are using a GitHub account, you will have to install the Iterative Studio
GitHub app on the GitHub repositories/organizations that you want to use with
Iterative Studio. When you try to add a project, if the app is not already
installed, Iterative 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.
# Install the Iterative Studio GitHub App

If you are using a GitHub account, you can install the Iterative 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
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.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Git repositories in two ways:
have an ML project for which you generate and save metrics either manually or
using some ML tracking tools, then you can add this project by specifying the
file (within your Git repo) which contains your saved metrics. Refer to the
section on
[project settings](/doc/studio/user-guide/projects/project-settings#non-dvc-repositories)
to learn how to specify the custom files.
section [on project settings] to learn how to specify the custom files.

[on project settings]:
/doc/studio/user-guide/projects-and-experiments/configure-a-project#non-dvc-repositories
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,13 @@ Additionally, you can also configure project settings to

### Non-DVC repositories

In the section on
[preparing your repositories](/doc/studio/user-guide/prepare-repositories), you
saw that you can use Iterative Studio with DVC as well as non-DVC repositories.
If you are connecting to a non-DVC repository, then you will need to
[specify the custom files](#custom-metrics-and-parameters) that contain the
metrics and hyperparameters that you want to visualize.
In the section on [preparing your repositories], you saw that you can use
Iterative Studio with DVC as well as non-DVC repositories. If you are connecting
to a non-DVC repository, then you will need to [specify the custom files] that
contain the metrics and hyperparameters that you want to visualize.

[preparing your repositories]: /doc/studio/user-guide/prepare-your-repositories
[specify the custom files]: #custom-metrics-and-parameters

### Monorepo

Expand Down Expand Up @@ -127,8 +128,7 @@ to a maximum of 200.

Note that some non-mandatory columns will also be imported if there are less
than 200 mandatory columns. If you would like to hide specific columns from your
project, you can do so in the project's
[Display preferences](/doc/studio/user-guide/projects/explore-experiments#columns).
project, you can do so in the project's [Display preferences].

If your project is missing some required columns or includes columns that you do
not want, refer to the following troubleshooting sections to understand why this
Expand All @@ -139,6 +139,9 @@ may have happened.

Note: The **Mandatory columns** section was earlier called **Tracking scope**.

[display preferences]:
/doc/studio/user-guide/projects-and-experiments/explore-ml-experiments#columns

### Custom metrics and parameters

If you want to connect custom files, you can add them by clicking the `Add file`
Expand Down
Loading