From a1318d1f18fa8a7de73f6f99d63234e1cf7b58ae Mon Sep 17 00:00:00 2001 From: Emeli Dral Date: Wed, 4 Dec 2024 18:29:16 +0000 Subject: [PATCH] No team_id in docs (#1381) * 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 --- .../book/examples/cookbook_llm_regression_testing.md | 4 ++-- docs/book/examples/tutorial-llm.md | 6 +++--- docs/book/get-started/cloud_quickstart_llm.md | 7 +++---- docs/book/get-started/cloud_quickstart_tabular.md | 7 +++---- docs/book/get-started/cloud_quickstart_tracing.md | 2 +- docs/book/installation/cloud_account.md | 10 +--------- docs/book/projects/add_project.md | 12 +++--------- 7 files changed, 16 insertions(+), 32 deletions(-) diff --git a/docs/book/examples/cookbook_llm_regression_testing.md b/docs/book/examples/cookbook_llm_regression_testing.md index a825c1bad1..95a79e9b4a 100644 --- a/docs/book/examples/cookbook_llm_regression_testing.md +++ b/docs/book/examples/cookbook_llm_regression_testing.md @@ -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 diff --git a/docs/book/examples/tutorial-llm.md b/docs/book/examples/tutorial-llm.md index 0c821ca1da..a137b3aaff 100644 --- a/docs/book/examples/tutorial-llm.md +++ b/docs/book/examples/tutorial-llm.md @@ -137,7 +137,7 @@ 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. @@ -145,10 +145,10 @@ To be able to save and share results and get a live monitoring dashboard, create 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() ``` diff --git a/docs/book/get-started/cloud_quickstart_llm.md b/docs/book/get-started/cloud_quickstart_llm.md index d3c03d5050..3e58d2df61 100644 --- a/docs/book/get-started/cloud_quickstart_llm.md +++ b/docs/book/get-started/cloud_quickstart_llm.md @@ -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. @@ -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() ``` diff --git a/docs/book/get-started/cloud_quickstart_tabular.md b/docs/book/get-started/cloud_quickstart_tabular.md index 61eb20656f..e629e25ea1 100644 --- a/docs/book/get-started/cloud_quickstart_tabular.md +++ b/docs/book/get-started/cloud_quickstart_tabular.md @@ -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. @@ -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() ``` diff --git a/docs/book/get-started/cloud_quickstart_tracing.md b/docs/book/get-started/cloud_quickstart_tracing.md index a3c8fbb086..aca2375592 100644 --- a/docs/book/get-started/cloud_quickstart_tracing.md +++ b/docs/book/get-started/cloud_quickstart_tracing.md @@ -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( diff --git a/docs/book/installation/cloud_account.md b/docs/book/installation/cloud_account.md index 54a70a02db..10d60e1a57 100644 --- a/docs/book/installation/cloud_account.md +++ b/docs/book/installation/cloud_account.md @@ -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. diff --git a/docs/book/projects/add_project.md b/docs/book/projects/add_project.md index 6cbdbeb038..9c7f0882e5 100644 --- a/docs/book/projects/add_project.md +++ b/docs/book/projects/add_project.md @@ -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() ``` @@ -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)