From 3160b4382181ac9545ef2c17ea2e362969124e36 Mon Sep 17 00:00:00 2001
From: Daniel <63580393+danrgll@users.noreply.github.com>
Date: Thu, 25 Jan 2024 14:27:17 +0100
Subject: [PATCH] add commment to multi fidelity example for clarification

---
 neps_examples/efficiency/multi_fidelity.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/neps_examples/efficiency/multi_fidelity.py b/neps_examples/efficiency/multi_fidelity.py
index 4239aee7..0731b1b5 100644
--- a/neps_examples/efficiency/multi_fidelity.py
+++ b/neps_examples/efficiency/multi_fidelity.py
@@ -37,6 +37,11 @@ def get_model_and_optimizer(learning_rate):
     return model, optimizer
 
 
+# Important: Include the "pipeline_directory" and "previous_pipeline_directory" arguments
+# in your run_pipeline function. This grants access to NePS's folder system and is
+# critical for leveraging efficient multi-fidelity optimization strategies.
+
+
 def run_pipeline(pipeline_directory, previous_pipeline_directory, learning_rate, epoch):
     model, optimizer = get_model_and_optimizer(learning_rate)
     checkpoint_name = "checkpoint.pth"