This page explains how to self-host the lightweight open-source platform. Contact us for Enterprise version with extra features and support. Compare OSS vs. Enterprise/Cloud.
- Create a Workspace (local or remote) to store your data.
- Launch the UI service.
1. Create a Workspace
Sign up for a free Evidently Cloud account to get a managed version instantly.
workspace
. This designates a remote or local directory where you will store the evaluation results (JSON Reports called snapshots
). The UI Service will read the data from this source.
There are three scenarios, based on where you run the UI Service and store data.
- Local Workspace. Both the UI Service and data storage are local.
- Remote Workspace. Both the UI Service and data storage are remote.
- Workspace with remote data storage. Run the UI Service and store data on different servers.
Local Workspace
Here, you generate, store the snapshots and run the monitoring UI on the same machine. Imports:path
parameter to specify the path to a local directory.
Remote Workspace
Code example (Docker). See the remote service example.
Parameter | Description |
---|---|
self.base_url = base_url | URL for the remote UI service. |
self.secret = secret | String with secret, None by default. Use it if access to the URL is protected by a password. |
Remote snapshot storage
In the examples above, you store the snapshots and run the UI on the same server. Alternatively, you can store snapshots in a remote data store (such as an S3 bucket). The Monitoring UI service will interface with the designated data store to read the snapshot data. To connect to data stores Evidently usesfsspec
that allows accessing data on remote file systems via a standard Python interface.
You can verify supported data stores in the Fsspec documentation (built-in implementations and other implementations).
For example, to read snapshots from an S3 bucket (with MinIO running on localhost:9000), you must specify environment variables:
[DANGER] Delete Workspace
To delete a Workspace, run the command from the Terminal:You are deleting all the data. This command will delete all the data stored in the workspace folder. To maintain access to the generated Reports, you must store them elsewhere.
2. Launch the UI service
To launch the Evidently UI service, you must run a command in the Terminal. Option 1. If you log snapshots to a local Workspace directory, you run Evidently UI over it. Run the following command from the directory where the Workspace folder is located.Demo projects
To launch the Evidently service with the demo projects, run:Tutorial
Check this tutorial for an end-to-end example:Evidently UI tutorial
How to create a workspace, project and run Reports.