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

​
Upload a Dataset

Prepare your dataset as an Evidently Dataset with the corresponding data definition. To upload a Dataset to the specified Project in workspace ws, use the add_dataset method:

eval_data = Dataset.from_pandas(
    pd.DataFrame(source_df),
    data_definition=DataDefinition()
)
ws.add_dataset(
    dataset = eval_data, 
    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.

How to create an Evidently Dataset? Read the Data Definition docs.

​
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:

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

#to create as pandas dataframe
df = eval_dataset.as_dataframe()

​
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.