Implementation:Evidentlyai Evidently Project Add And Configure
Appearance
| Knowledge Sources | |
|---|---|
| Domains | ML_Monitoring, Infrastructure |
| Last Updated | 2026-02-14 12:00 GMT |
Overview
Concrete methods for creating and configuring monitoring projects within an Evidently Workspace provided by the Evidently library.
Description
Workspace.add_project() creates a new Project from a ProjectModel and returns a Project object with name, description, id, and dashboard properties. The Project's dashboard property provides methods for adding panels.
Usage
Call after Workspace.create() to create a monitoring project.
Code Reference
Source Location
- Repository: evidently
- File: src/evidently/ui/workspace.py
- Lines: L146-265 (Project class), L782-794 (Workspace.add_project)
Signature
class Workspace:
def add_project(
self,
project: ProjectModel,
org_id: Optional[OrgID] = None,
) -> Project:
"""Add a new project to the workspace.
Args:
project: ProjectModel with name and configuration.
org_id: Optional organization ID.
Returns:
Project object.
"""
class Project:
# Properties: id, name, description, dashboard
def save(self):
"""Persist project changes."""
Import
from evidently.ui.workspace import Workspace
from evidently.ui.workspace import ProjectModel # or create inline
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| project | ProjectModel | Yes | Project configuration with name field |
| org_id | Optional[OrgID] | No | Organization identifier |
Outputs
| Name | Type | Description |
|---|---|---|
| return value | Project | Project with id, name, description, dashboard properties |
Usage Examples
from evidently.ui.workspace import Workspace
ws = Workspace.create("monitoring")
# Create project
from evidently.ui.workspace import ProjectModel
project = ws.add_project(ProjectModel(name="Fraud Detection Model"))
project.description = "Production fraud detection monitoring"
project.save()
print(f"Project ID: {project.id}")
Related Pages
Implements Principle
Requires Environment
Page Connections
Double-click a node to navigate. Hold to expand connections.
Principle
Implementation
Heuristic
Environment