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 5 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 @@ -552,46 +552,27 @@
]
},
{
"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": "Views and Experiments",
"slug": "views",
"slug": "views-and-experiments",
"source": false,
"children": [
"what-is-a-view",
"create-view",
{
"label": "Configure View",
"slug": "view-settings"
},
{
"label": "Explore ML Experiments",
"slug": "explore-experiments"
},
{
"label": "Visualize and Compare",
"slug": "visualize-experiments"
},
"create-a-view",
"configure-a-view",
"explore-ml-experiments",
"visualize-and-compare",
"run-experiments",
"share-view"
"share-a-view"
]
},
"teams",
Expand Down
34 changes: 18 additions & 16 deletions content/docs/studio/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,33 +70,35 @@ more views._
> 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 view settings after the view has been created. So, you
> can `Skip and Continue` now. Refer to the
> [View Settings](/doc/studio/user-guide/views/view-settings) section for more
> can `Skip and Continue` now. Refer to the [View Settings] section for more
> details.

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

7. If your project requires any of the additional settings, then remember to
configure them by opening the
[view settings](/doc/studio/user-guide/views/view-settings). Otherwise, your
view may not work as expected. To go to view settings, click on the
configure them by opening the [view settings]. Otherwise, your view may not
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
work as expected. To go to view settings, click on the
![](https://static.iterative.ai/img/studio/view_open_settings_icon.png) icon
in the view. In the menu that opens up, click on `Settings`.

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

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

9. After creating a view, 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 view, you can use it to [explore the ML experiments] as well
as [submit new experiments] from Iterative Studio.

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

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

[view settings]: /doc/studio/user-guide/views-and-experiments/create-a-view
[create multiple views from a single git repository]:
tapadipti marked this conversation as resolved.
Show resolved Hide resolved
/doc/studio/user-guide/views-and-experiments/create-a-view#create-multiple-views-from-a-single-git-repository
[explore the ml experiments]: /doc/studio/user-guide/explore-ml-experiments
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
[submit new experiments]: /doc/studio/user-guide/run-experiments
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
[sharing it on the web]:
/doc/studio/user-guide/views-and-experiments/share-a-view
[create a team]: /doc/studio/user-guide/teams
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
16 changes: 9 additions & 7 deletions content/docs/studio/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# 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 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 enables you to seamlessly manage data
and models, and to run, visualize, and share machine learning experiments. This
is possible with the power of DVC and CML, our leading open-source tools for
data science.

Iterative Studio works with the data, metrics and hyperparameters that you add
to your ML project repositories.

<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
18 changes: 9 additions & 9 deletions content/docs/studio/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ Otherwise, you will get this message when you try to create a view:
`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).
[how to prepare your Git repositories for use with Iterative Studio](/doc/studio/user-guide/prepare-your-repositories).
Instructions on how to specify custom files can be found
[here](/doc/studio/user-guide/views/view-settings#configuring-view-settings).
[here](/doc/studio/user-guide/views-and-experiments/create-a-view#configuring-view-settings).

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

Expand All @@ -51,7 +51,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/views/view-settings#configuring-view-settings).
[here](/doc/studio/user-guide/views-and-experiments/create-a-view#configuring-view-settings).

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

Expand All @@ -74,7 +74,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/views/view-settings#configuring-view-settings).
[here](/doc/studio/user-guide/views-and-experiments/create-a-view#configuring-view-settings).

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

Expand All @@ -89,7 +89,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/views/view-settings#configuring-view-settings).
[here](/doc/studio/user-guide/views-and-experiments/create-a-view#configuring-view-settings).

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

Expand All @@ -101,7 +101,7 @@ 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/views/view-settings#configuring-view-settings).
[here](/doc/studio/user-guide/views-and-experiments/create-a-view#configuring-view-settings).

## View does not contain the columns that I want

Expand All @@ -110,7 +110,7 @@ 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/views/view-settings#mandatory-columns).
[select the columns that are mandatory to import](/doc/studio/user-guide/views-and-experiments/create-a-view#mandatory-columns).
Iterative Studio will also import the unselected columns, but only up to a
maximum of 200 columns.

Expand All @@ -122,7 +122,7 @@ There are two possible reasons for this:
can create a new view that is limited to that subdirectory.

To create views for subdirectories,
[specify the project directory in view settings](/doc/studio/user-guide/views/view-settings#project-directory).
[specify the project directory in view settings](/doc/studio/user-guide/views-and-experiments/create-a-view#project-directory).

If this solution does not work for your use case, please create a support
ticket in the
Expand Down Expand Up @@ -160,7 +160,7 @@ else in your team.

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

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 create a view, 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.
# 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 view, if the app is not already installed, Iterative
tapadipti marked this conversation as resolved.
Show resolved Hide resolved
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.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ Git repositories in two ways:
either manually or using some ML tracking tools, then you can create a view
for this project by specifying the file (within your Git repo) which contains
your saved metrics. Refer to the section on
[view settings](/doc/studio/user-guide/views/view-settings#non-dvc-repositories)
[view settings](/doc/studio/user-guide/views-and-experiments/create-a-view#non-dvc-repositories)
to learn how to specify the custom files.
7 changes: 4 additions & 3 deletions content/docs/studio/user-guide/teams.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,15 +110,16 @@ This is the views dashboard for the team. All the views on this dashboard are
accessible to all members (collaborators) of the team.

To add a view to this dashboard, click on `Add a view`. The process for adding a
view is the same as that for adding personal views
([instructions](/doc/studio/user-guide/views/create-view)).
view is the same as that for adding personal views (see [instructions]).

[instructions](/doc/studio/user-guide/views-and-experiments/create-a-view)

## Settings

In the team settings page, you can change the team name, add credentials for the
data remotes, and delete the team. Note that these settings are applicable to
the team and are thus different from
[view settings](/doc/studio/user-guide/views/view-settings).
[view settings](/doc/studio/user-guide/views-and-experiments/create-a-view).

Additionally, you can also
[manage connections to self-hosted GitLab servers](#manage-connections-to-self-hosted-gitlab-servers),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,13 @@ Additionally, you can also configure view 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 @@ -119,7 +120,7 @@ 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
view, you can do so in the view itself. For this, refer to
[Display preferences -> Columns](/doc/studio/user-guide/views/explore-experiments#columns).
[Display preferences -> Columns](/doc/studio/user-guide/views-and-experiments/explore-ml-experiments#columns).

If your view is missing some required columns or includes columns that you do
not want, refer to the following troubleshooting sections to understand why this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,16 @@ for more details.
> a monorepo, or if your metrics are in cloud or other remote storage. However,
> you can configure the view settings after the view has been created. So, you
> can `Skip and Continue` now. Refer to the
> [View Settings](/doc/studio/user-guide/views/view-settings) section for more
> details.
> [View Settings](/doc/studio/user-guide/views-and-experiments/create-a-view)
> section for more details.

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

5. If your project requires any of the additional settings, then remember to
configure them by opening the
[view settings](/doc/studio/user-guide/views/view-settings). Otherwise, your
view may not work as expected. To go to view settings, click on the
[view settings](/doc/studio/user-guide/views-and-experiments/create-a-view).
Otherwise, your view may not work as expected. To go to view settings, click
on the
![](https://static.iterative.ai/img/studio/view_open_settings_icon.png) icon
in the view. In the menu that opens up, click on `Settings`.

Expand All @@ -88,9 +89,10 @@ for multiple ML projects. If you want to create views for each of those ML
projects, simply create multiple views for this monorepo, and for each view,
specify a different sub-directory.

Refer to the [View Settings](/doc/studio/user-guide/views/view-settings) section
for more details on how to configure different settings (and sub-directories)
for the views.
Refer to the
[View Settings](/doc/studio/user-guide/views-and-experiments/create-a-view)
section for more details on how to configure different settings (and
sub-directories) for the views.

## Create views shared across a team

Expand Down
9 changes: 8 additions & 1 deletion redirects-list.json
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,14 @@
"^/doc/cml(/.*)?$ https://cml.dev/doc$1",

"^/doc/studio/view-settings$ /doc/studio/user-guide/views/view-settings",
"^/doc/studio/user-guide/explore-experiments$ /doc/studio/user-guide/views/explore-experiments",
"^/doc/studio/overview$ /doc/studio/user-guide/views/how-it-works",
"^/doc/studio/user-guide/prepare-repositories$ /doc/studio/user-guide/prepare-your-repositories",
"^/doc/studio/user-guide/views/create-view$ /doc/studio/user-guide/views-and-experiments/create-a-view",
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
"^/doc/studio/user-guide/views/view-settings$ /doc/studio/user-guide/views-and-experiments/configure-a-view",
"^/doc/studio/user-guide/views/explore-experiments$ /doc/studio/user-guide/views-and-experiments/explore-ml-experiments",
"^/doc/studio/user-guide/views/visualize-experiments$ /doc/studio/user-guide/views-and-experiments/visualize-and-compare",
"^/doc/studio/user-guide/views/share-view$ /doc/studio/user-guide/views-and-experiments/share-a-view",
"^/doc/studio/user-guide/views(/.*)?$ /doc/studio/user-guide/views-and-experiments$1",
"^/doc/studio/user-guide/visualize-experiments$ /doc/studio/user-guide/views/visualize-experiments",
"^/doc/studio/user-guide/run-experiments$ /doc/studio/user-guide/views/run-experiments",

Expand Down