Skip to content

Commit

Permalink
Specify the different formats recording_name should ahve in FitnessCa…
Browse files Browse the repository at this point in the history
…lculatorConfiguration docstring

Change-Id: I65c73fdc58c7076a40618bb1f424c755ba7f899e
  • Loading branch information
Jaquier Aurélien Tristan committed Oct 3, 2023
1 parent 406403b commit aa01439
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions bluepyemodel/evaluation/fitness_calculator_configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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"``
Expand Down

0 comments on commit aa01439

Please sign in to comment.