Set up an evaluation or monitoring Project.
You must first connect to Evidently Cloud (or your local workspace).
To create a Project inside a workspace ws
and Organization with an org_id
:
In self-hosted open-source installation, you do not need to pass the Org ID. To create a Project:
To create a Project inside a workspace ws
and Organization with an org_id
:
In self-hosted open-source installation, you do not need to pass the Org ID. To create a Project:
Create a Project. Click on the “plus” sign on the home page, set a Project name and description.
Edit a Project. To change the Project name or description, hover on the existing Project, click “edit” and make the changes.
Project ID. You can see the Project ID above the monitoring Dashboard inside your Project.
To connect to an existing Project from Python, use the get_project
method.
After making any changes to the Project (like editing description or adding monitoring Panels), always use the save()
command:
You can see all available Projects on the monitoring homepage, or request a list programmatically. To get a list of all Projects in a workspace ws
, use:
To find a specific Project by its name, use the search_project
method:
Deleting a Project deletes all the data inside it.
To delete the Project:
To delete the Project:
Hover on the existing Project and click “delete”.
Each Project has the following parameters.
Parameter | Description | Example |
---|---|---|
name: str | Project name. | - |
id: UUID4 = Field(default_factory=uuid.uuid4) | Unique identifier of the Project. Assigned automatically. | - |
description: Optional[str] = None | Optional description. Visible when you browse Projects. | - |
dashboard: DashboardConfig | Dashboard configuration that describes the composition of the monitoring Panels. | See Dashboard Design for details. You don’t need to explicitly pass DashboardConfig if you use the .dashboard.add_panel method. |
date_from: Optional[datetime.datetime] = None | Start DateTime of the monitoring Dashboard. By default it shows data for all available periods. | datetime.now() + timedelta(-30) |
date_to: Optional[datetime.datetime] = None | End DateTime of the monitoring Dashboard. | Works the same as date_from . |
Set up an evaluation or monitoring Project.
You must first connect to Evidently Cloud (or your local workspace).
To create a Project inside a workspace ws
and Organization with an org_id
:
In self-hosted open-source installation, you do not need to pass the Org ID. To create a Project:
To create a Project inside a workspace ws
and Organization with an org_id
:
In self-hosted open-source installation, you do not need to pass the Org ID. To create a Project:
Create a Project. Click on the “plus” sign on the home page, set a Project name and description.
Edit a Project. To change the Project name or description, hover on the existing Project, click “edit” and make the changes.
Project ID. You can see the Project ID above the monitoring Dashboard inside your Project.
To connect to an existing Project from Python, use the get_project
method.
After making any changes to the Project (like editing description or adding monitoring Panels), always use the save()
command:
You can see all available Projects on the monitoring homepage, or request a list programmatically. To get a list of all Projects in a workspace ws
, use:
To find a specific Project by its name, use the search_project
method:
Deleting a Project deletes all the data inside it.
To delete the Project:
To delete the Project:
Hover on the existing Project and click “delete”.
Each Project has the following parameters.
Parameter | Description | Example |
---|---|---|
name: str | Project name. | - |
id: UUID4 = Field(default_factory=uuid.uuid4) | Unique identifier of the Project. Assigned automatically. | - |
description: Optional[str] = None | Optional description. Visible when you browse Projects. | - |
dashboard: DashboardConfig | Dashboard configuration that describes the composition of the monitoring Panels. | See Dashboard Design for details. You don’t need to explicitly pass DashboardConfig if you use the .dashboard.add_panel method. |
date_from: Optional[datetime.datetime] = None | Start DateTime of the monitoring Dashboard. By default it shows data for all available periods. | datetime.now() + timedelta(-30) |
date_to: Optional[datetime.datetime] = None | End DateTime of the monitoring Dashboard. | Works the same as date_from . |