Level: Intermediate

• Time to complete: 15 minutes
• Prerequisites:
  • This tutorial assumes a basic knowledge of NLP and the concept of pipeline evaluation. If you need more information, look at About Pipeline Evaluation.
  • You must be an Admin to complete this tutorial.
• Goal: After completing this tutorial, you will have created and run an experiment to evaluate a pipeline.

Upload Files

Your pipeline will run the search on these files.

1. Download the .zip file with sample files and unpack it on your computer.

2. Log in to deepset Cloud, make sure you're in the right workspace, and go to Data>Files.

3. Click Upload Files.

4. Select all the files you extracted and drop them into the Upload Files window. There should be 344 files in total.

5. Click Upload and wait until the files are uploaded.

Result: Your files are in your workspace, and you can see them on the Files page.

Upload an Evaluation Set

You need a set of annotated data your pipeline will be evaluated against.

1. Download the CSV file and save it on your computer.
2. In deepset Cloud, go to Data>Evaluation Sets and click Upload Evaluation Sets.
3. Drop the CSV file you downloaded in step 1 in the Upload Evaluation Sets window and click Upload. Wait for the confirmation that it uploaded without problems.

Result: The evaluation dataset is uploaded, and you can see it on the Evaluation Sets page.

Create a Pipeline to Run the Experiment On

1. In deepset Cloud, go to Pipelines>New Pipeline.

2. In YAML Editor, click Create Pipeline and select From Template.

3. Choose the English Question Answering template.

4. In the YAML editor, in line 8, find name and change it to 'Test_experiment'.

5. In line 17, change the retriever type to ElasticsearchRetriever and delete lines 20 and 21 (embedding_model and model_format).

6. Change the top_k parameter value in line 22 to 10.
   This is what your pipeline should look like now:

7. Save your pipeline.

Result: You have created a question answering pipeline that you'll evaluate next. Your pipeline is displayed on the Pipelines page.

Create an Experiment

Now it's time to evaluate your pipeline.

1. Go to Experiments>New Experiment.

2. Choose Test_experiment as the pipeline.

3. Choose annotations_jazz as the evaluation set.

4. Type jazz as the experiment name and add test as a tag.

5. Click Start Experiment. You can see that jazz is running. Wait until it completes. It may take a couple of minutes.

6. When the experiment status changes to Completed, click its name to view its details, such as the data and the pipeline used, the metrics, and predictions.

Result: Congratulations! You just created an experiment and ran it to evaluate your pipeline.

You can now review the results on the experiment details page.