From aa01439c31aee09f62be40c1b0ef42a0e9ac75dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jaquier=20Aur=C3=A9lien=20Tristan?= Date: Tue, 3 Oct 2023 16:05:14 +0200 Subject: [PATCH] Specify the different formats recording_name should ahve in FitnessCalculatorConfiguration docstring Change-Id: I65c73fdc58c7076a40618bb1f424c755ba7f899e --- bluepyemodel/evaluation/fitness_calculator_configuration.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/bluepyemodel/evaluation/fitness_calculator_configuration.py b/bluepyemodel/evaluation/fitness_calculator_configuration.py index 989fca5c..40148bf6 100644 --- a/bluepyemodel/evaluation/fitness_calculator_configuration.py +++ b/bluepyemodel/evaluation/fitness_calculator_configuration.py @@ -108,6 +108,9 @@ def __init__( {"efel_feature_name": str, "protocol_name": str, "recording_name": str, "mean": float, "std": float, "efel_settings": dict} ] + + here, recording_name should have the format ``f"{protocol_name}.{location}.v"``, + e.g. ``"IV_0.soma.v"`` protocols (list of dict): contains the description of the protocols of the model in the format returned by the method as_dict of the ProtocolConfiguration class: @@ -117,6 +120,8 @@ def __init__( {"name": str, "stimuli": list of dict, "recordings": list of dict, "validation": bool} ] + + here, recording_name should have the format ``f"{location}.v"``, e.g. ``"soma.v"`` name_rmp_protocol (str or list): name and amplitude of protocol whose features are to be used as targets for the search of the RMP. e.g: ``["IV", 0]`` or ``"IV_0"``