/ src / evidently / ui / __init__.py
__init__.py
 1  """UI and workspace management for storing and visualizing evaluations.
 2  
 3  This module provides interfaces for:
 4  - `Workspace`: Local file-based storage for projects and runs
 5  - `RemoteWorkspace`: Remote API-based storage
 6  - `CloudWorkspace`: Evidently Cloud storage
 7  - `EvidentlyUIRunner`: Run the Evidently UI service
 8  
 9  Workspaces allow you to persist evaluation results, organize them into projects,
10  and visualize them over time. Use workspaces to:
11  - Store multiple evaluation runs
12  - Compare results across time or model versions
13  - Build dashboards with custom visualizations
14  - Share results with your team
15  
16  **Documentation**:
17  - [Platform Overview](https://docs.evidentlyai.com/docs/platform/overview) for workspace concepts
18  - [Self-hosting Guide](https://docs.evidentlyai.com/docs/setup/self-hosting) for local setup
19  
20  Example:
21  ```python
22  from evidently.ui import Workspace
23  
24  workspace = Workspace.create("my_workspace")
25  project = workspace.add_project(ProjectModel(name="My Project"))
26  workspace.add_run(project.id, snapshot)
27  ```
28  """
29  
30  from evidently.ui import runner
31  from evidently.ui import workspace
32  
33  __all__ = ["workspace", "runner"]