Skip to content

Commit

Permalink
No team_id in docs (#1381)
Browse files Browse the repository at this point in the history
* Update cloud_quickstart_llm.md

* Update cloud_quickstart_tabular.md

* Update cloud_quickstart_llm.md

* Update tutorial-llm.md

* Update cloud_quickstart_tracing.md

* Update cookbook_llm_regression_testing.md

* Update cloud_account.md

* Update add_project.md
  • Loading branch information
emeli-dral authored Dec 4, 2024
1 parent c7e90e2 commit a1318d1
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 32 deletions.
4 changes: 2 additions & 2 deletions docs/book/examples/cookbook_llm_regression_testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,13 @@ ws = CloudWorkspace(token="YOUR_API_TOKEN", url="https://app.evidently.cloud")
Create a Project:

```python
project = ws.create_project("Regression testing example", team_id="YOUR_TEAM_ID")
project = ws.create_project("Regression testing example", org_id="YOUR_ORG_ID")
project.description = "My project description"
project.save()
```

{% hint style="info" %}
**Need help?** Check how to find API key and [create a Team](../installation/cloud_account.md).
**Need help?** Check how to find [API key](../installation/cloud_account.md).
{% endhint %}

# 3. Prepare the Dataset
Expand Down
6 changes: 3 additions & 3 deletions docs/book/examples/tutorial-llm.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,18 +137,18 @@ assistant_logs.head(3)
To be able to save and share results and get a live monitoring dashboard, create a Project in Evidently Cloud. Here's how to set it up:

* **Sign up**. If you do not have one yet, create a free [Evidently Cloud account](https://app.evidently.cloud/signup) and name your Organization.
* **Add a Team**. Click **Teams** in the left menu. Create a Team, copy and save the Team ID. ([Team page](https://app.evidently.cloud/teams)).
* **Create an Organization** when you log in for the first time. Get an ID of your organization. [Organizations page](https://app.evidently.cloud/organizations).
* **Get your API token**. Click the **Key** icon in the left menu to go. Generate and save the token. ([Token page](https://app.evidently.cloud/token)).
* **Connect to Evidently Cloud**. Pass your API key to connect.

```python
ws = CloudWorkspace(token="YOUR_TOKEN",
url="https://app.evidently.cloud")
```
* **Create a Project**. Create a new Project inside your Team, adding your title and description:
* **Create a Project**. Create a new Project inside your Organization, adding your title and description:

```python
project = ws.create_project("My project title", team_id="YOUR_TEAM_ID")
project = ws.create_project("My project title", org_id="YOUR_ORG_ID")
project.description = "My project description"
project.save()
```
Expand Down
7 changes: 3 additions & 4 deletions docs/book/get-started/cloud_quickstart_llm.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ Need help? Ask on [Discord](https://discord.com/invite/xZjKRaNp8b).

Set up your Evidently Cloud workspace:
* **Sign up** for a free [Evidently Cloud account](https://app.evidently.cloud/signup).
* **Create an Organization** when you log in for the first time.
* **Create a Team**. Click Teams in the left menu, create a Team, and save the Team ID ([Team page](https://app.evidently.cloud/teams)).
* **Create an Organization** when you log in for the first time. Get an ID of your organization. [Organizations page](https://app.evidently.cloud/organizations).
* **Get your API token**. Click the **Key** icon in the left menu. Generate and save the token. ([Token page](https://app.evidently.cloud/token)).

Now, switch to your Python environment.
Expand Down Expand Up @@ -49,10 +48,10 @@ Connect to Evidently Cloud using your API token:
ws = CloudWorkspace(token="YOUR_API_TOKEN", url="https://app.evidently.cloud")
```

Create a Project within your Team:
Create a Project within your Organization:

```python
project = ws.create_project("My test project", team_id="YOUR_TEAM_ID")
project = ws.create_project("My test project", org_id="YOUR_ORG_ID")
project.description = "My project description"
project.save()
```
Expand Down
7 changes: 3 additions & 4 deletions docs/book/get-started/cloud_quickstart_tabular.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ description: ML Monitoring “Hello world.” From data to dashboard in a couple

Set up your Evidently Cloud workspace:
* **Sign up**. If you do not have one yet, sign up for a free [Evidently Cloud account](https://app.evidently.cloud/signup).
* **Create an Organization**. When you log in the first time, create and name your Organization.
* **Create a Team**. Click **Teams** in the left menu. Create a Team, copy and save the Team ID. ([Team page](https://app.evidently.cloud/teams)).
* **Create an Organization** when you log in for the first time. Get an ID of your organization. [Organizations page](https://app.evidently.cloud/organizations).
* **Get your API token**. Click the **Key** icon in the left menu. Generate and save the token. ([Token page](https://app.evidently.cloud/token)).

You can now go to your Python environment.
Expand Down Expand Up @@ -39,10 +38,10 @@ Connect to Evidently Cloud using your access token.
ws = CloudWorkspace(token="YOUR_TOKEN_HERE", url="https://app.evidently.cloud")
```

Create a new Project inside your Team. Pass the `team_id`.
Create a new Project inside your Organization. Pass the `org_id`.

```python
project = ws.create_project("My test project", team_id="YOUR_TEAM_ID")
project = ws.create_project("My test project", org_id="YOUR_ORG_ID")
project.description = "My project description"
project.save()
```
Expand Down
2 changes: 1 addition & 1 deletion docs/book/get-started/cloud_quickstart_tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Initialize the OpenAI client. Pass the token as an environment variable:
client = openai.OpenAI(api_key=os.getenv("OPENAI_API_KEY"))
```

Set up tracing parameters. Copy the Team ID from the [Teams page](https://app.evidently.cloud/teams), and give a name to identify your tracing dataset.
Set up tracing parameters. Give it a name to identify your tracing dataset.

```python
init_tracing(
Expand Down
10 changes: 1 addition & 9 deletions docs/book/installation/cloud_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,7 @@ If not yet, [sign up for a free Evidently Cloud account](https://app.evidently.c

After logging in, create an **Organization** and name it.

# 3. Create a Team

Go to the **Teams** icon in the left menu, create a Team, and name it. ([Team page](https://app.evidently.cloud/teams)).

{% hint style="info" %}
**Do I always need a Team?** Yes. Every Project must be within a Team. Teams act as "folders" to organize your work, and you can create multiple Teams. If you work alone, simply create a Team without external users.
{% endhint %}

# 4. Connect from Python
# 3. Connect from Python

You will need an access token to interact with Evidently Cloud from your Python environment.

Expand Down
12 changes: 3 additions & 9 deletions docs/book/projects/add_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,10 @@ You can create a Project using the Python API or directly in the user interface.

## Add a new Project - API

{% hint style="success" %}
Team management is a Pro feature available in the `Evidently Cloud` and `Evidently Enterprise`.
{% endhint %}

In Evidently Cloud and Enterprise, you must create a Team before adding a Project. To get your Team ID, go to the [Teams page](https://app.evidently.cloud/teams), select your Team, and copy the ID from there.

To create a Project inside a workspace `ws` and Team with a `team_id`, assign a name and description, and save the changes:
To create a Project inside a workspace `ws` and Organization ([see organizations](https://app.evidently.cloud/organizations)) with an `org_id`, assign a name and description, and save the changes:

```
project = ws.create_project("My test project", team_id="YOUR_TEAM_ID")
project = ws.create_project("My test project", org_id="YOUR_ORG_ID")
project.description = "My project description"
project.save()
```
Expand All @@ -37,7 +31,7 @@ project.save()

## Add a new Project - UI

Click on the “plus” sign on the home page, create a Team if you do not have one yet and type your Project name and description.
Click on the “plus” sign on the home page, type your Project name and description.

![](../.gitbook/assets/cloud/add_project_wide-min.png)

Expand Down

0 comments on commit a1318d1

Please sign in to comment.