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

Docs - update on teams #1123

Closed
wants to merge 25 commits into from
Closed
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
bf4b915
Update monitoring_overview.md
elenasamuylova May 15, 2024
4c97407
Update monitoring_overview.md
elenasamuylova May 15, 2024
542fb17
Update workspace.md
elenasamuylova May 15, 2024
68ffaf3
Update workspace.md
elenasamuylova May 15, 2024
9fe5191
Update workspace.md
elenasamuylova May 15, 2024
b818f14
Update add_project.md
elenasamuylova May 15, 2024
b93a795
Update add_project.md
elenasamuylova May 15, 2024
cd34f49
Update add_project.md
elenasamuylova May 15, 2024
2d0b4ae
Update add_project.md
elenasamuylova May 15, 2024
8e2b2a9
Update snapshots.md
elenasamuylova May 15, 2024
6f6e5b3
Update add_dashboard_tabs.md
elenasamuylova May 15, 2024
c5ec44a
Update design_dashboard.md
elenasamuylova May 15, 2024
851d44d
Update design_dashboard.md
elenasamuylova May 15, 2024
08d9428
Update design_dashboard_api.md
elenasamuylova May 15, 2024
3447170
Update alerting.md
elenasamuylova May 15, 2024
e2f65ac
Update alerting.md
elenasamuylova May 15, 2024
4fce772
Update snapshots.md
elenasamuylova May 15, 2024
7a4c112
Update collector_service.md
elenasamuylova May 15, 2024
cfacbaa
Update tutorial-cloud.md
elenasamuylova May 15, 2024
6d637b9
Merge branch 'evidentlyai:main' into main
elenasamuylova May 20, 2024
6d1a89d
Update quickstart-cloud.md
elenasamuylova May 23, 2024
360e58b
Update quickstart-cloud.md
elenasamuylova May 23, 2024
8bbd402
Update tutorial-cloud.md
elenasamuylova May 23, 2024
695104d
Update workspace.md
elenasamuylova May 23, 2024
6d6f533
Update quickstart-cloud.md
elenasamuylova May 23, 2024
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
20 changes: 13 additions & 7 deletions docs/book/get-started/quickstart-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,19 @@ description: ML Monitoring “Hello world.” From data to dashboard in a couple

# 1. Create an account

If not already, [sign up for an Evidently Cloud account](https://app.evidently.cloud/signup).
If not already, [sign up for an Evidently Cloud account](https://app.evidently.cloud/signup).

# 2. Get an access token
Upon registration, click on the "plus" sign in the UI to create a Team. For example, "Personal" team.

# 2. Copy the team ID

Go to the [Teams page](https://app.evidently.cloud/teams), copy and save the team ID.

# 3. Get an access token

Click on the left menu with a key sign, select "personal token," generate and save the token.

# 3. Install the Python library
# 4. Install the Python library

Install the Evidently Python library. You can run this example in Colab or another Python environment.

Expand All @@ -29,19 +35,19 @@ from evidently.report import Report
from evidently.metric_preset import DataQualityPreset
```

# 4. Create a new Project
# 5. Create a new Project

Connect to Evidently Cloud using your access token and create a Project.
Connect to Evidently Cloud using your access token and Team ID and create a Project.

```python
ws = CloudWorkspace(token="YOUR_TOKEN_HERE", url="https://app.evidently.cloud")
ws = CloudWorkspace(token="YOUR_TOKEN_HERE", team_id="YOUR_TEAM_ID_HERE", url="https://app.evidently.cloud")

project = ws.create_project("My test project")
project.description = "My project description"
project.save()
```

# 5. Collect metrics
# 6. Collect metrics

Import the demo "adult" dataset as a pandas DataFrame.

Expand Down
13 changes: 10 additions & 3 deletions docs/book/get-started/tutorial-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,13 @@ Let's quickly look at an example monitoring Dashboard.

If you do not have one yet, [create an Evidently Cloud account](https://app.evidently.cloud/signup).

## 2. View a demo project
## 2. Create a Team

After logging in, click on "Generate Demo Project". It will create a Project for a toy regression model that forecasts bike demand.
Upon registration, click on the "plus" sign in the UI to create a Team. For example, "Personal" team.

## 3. View a demo project

Click on "Generate Demo Project" inside your new Team. It will create a Project for a toy regression model that forecasts bike demand.

![](../.gitbook/assets/cloud/generate_demo_project.png)

Expand Down Expand Up @@ -175,12 +179,15 @@ Now, let's start monitoring!

**Get the API token**. To connect to Evidently Cloud, you need an access token. Use the "key" sign in the left menu to get to the token page, and click "generate token."

**Team ID**. Go to the [Teams page](https://app.evidently.cloud/teams), copy and save the team ID.

To connect to the Evidently Cloud workspace, run:

```python
ws = CloudWorkspace(
token="YOUR_TOKEN_HERE",
url="https://app.evidently.cloud")
url="https://app.evidently.cloud",
team_id="YOUR_TEAM_ID_HERE")
```

Now, you need to create a new Project. You can do this programmatically or in the UI.
Expand Down
7 changes: 5 additions & 2 deletions docs/book/monitoring/workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ You need a workspace to organize your data and Projects.

If you do not have one yet, create an [Evidently Cloud account](https://app.evidently.cloud/signup).

**Create a Team**. In the UI, create a new team - for example, "Personal". Copy the Team ID from [teams page](https://app.evidently.cloud/teams).

**Get the API token**. You will use it to connect with Evidently Cloud Workspace from your Python environment. Use the "key" sign in the left menu to get to the token page, and click "generate token." Save it in a temporary file since it won't be visible once you leave the page.

**Connect to the Workspace**. To connect to the Evidently Cloud Workspace, you must first [install Evidently](../installation/install-evidently.md).
Expand All @@ -21,14 +23,15 @@ If you do not have one yet, create an [Evidently Cloud account](https://app.evid
pip install evidently
```

Then, run imports and pass your API token to connect:
Then, run imports and pass your API token and Team ID to connect:

```python
from evidently.ui.workspace.cloud import CloudWorkspace

ws = CloudWorkspace(
token="YOUR_TOKEN_HERE",
url="https://app.evidently.cloud")
url="https://app.evidently.cloud",
team_id="YOUR_TEAM_ID")
```

{% hint style="info" %}
Expand Down
Loading