You must first connect to Evidently Cloud and create a Project.

​
Upload a Dataset

Prepare your dataset as a Pandas DataFrame. To upload a dataframe df to the specified Project in workspace ws, use the add_dataset method:

ws.add_dataset(
    df,
    name = "dataset_name",
    project_id = project.id, 
    description = "Optional description")

You must always specify the dataset name that you will see in the UI. The description is optional.

​
Download the Dataset

You can pull the Dataset stored or generated on the platform to your local environment. For example, call the evaluation or tracing dataset to use in a CI/CD testing script.

Use the load_dataset method:

downloaded_df = ws.load_dataset(dataset_id = "YOUR_DATASET_ID")

​
Include the Dataset

You can include Datasets when you upload Reports to the platform. This way, after running an evaluation locally you simultaneously upload:

  • the Report with evaluation result,

  • the Dataset it was generated for, with new added scores if applicable.

By default, you upload only the Report.

To include the Dataset, use the include_data parameter:

ws.add_run(project.id, data_report, include_data=True)

Check the docs on running evals via API for details.

OverviewSynthetic data