load_run#

gaitmap_challenges.results.load_run(challenge_class: Union[Type[BaseChallenge], BaseChallenge], folder_path: Union[str, Path]) data_return[source]#

Load the results of a run.

This uses the custom load functions of a challenge to load the results.

Parameters:
challenge_class

The challenge class to load the results for. Note, that we don’t explicitly check if the challenge class matches the results.

folder_path

The path to the folder where the run results are stored.

Returns:
ResultReturn

A named tuple containing the metadata, the results and the custom_metadata. The metadata is expected to have a similar structure for all challenges. However, the results and the custom metadata can be arbitrary and are controlled by the challenge and the actual run, respectively.