Challenge#

class gaitmap_challenges.spatial_parameters.egait_adidas_2014.Challenge(dataset: Optional[Union[str, Path, EgaitAdidas2014]], cv_iterator: Optional[Union[int, BaseCrossValidator, Iterator]] = GroupKFold(n_splits=5), cv_params: Optional[Dict] = None)[source]#

The EgaitAdidas Spatial Parameter Challenge.

Parameters:
dataset

A instance of EgaitAdidas2014 or a path to a directory containing the dataset.

cv_iterator

A cross-validation iterator or the number of folds to use.

cv_params

Additional parameters to pass to the tpcp cross-validation function.

Attributes:
cv_results_

The results of the cross-validation. This can be passed directly to the pandas DataFrame constructor to get a dataframe with the results.

See also

gaitmap_challenges.challenge_base.BaseChallenge

For common parameters and attributes of all challenges.

Methods

clone()

Create a new instance of the class with all parameters copied over.

get_core_results()

Get the main results of the challenge.

get_params([deep])

Get parameters for this algorithm.

load_core_results(folder_path)

Load the core results from a folder that have been stored using save_core_results.

run(optimizer)

Run the challenge.

save_core_results(folder_path)

Save the main results of the challenge to a folder.

set_params(**params)

Set the parameters of this Algorithm.

get_ground_truth_parameter

get_ground_truth_segmented_stride_list

get_imu_data

get_scorer

__init__(dataset: Optional[Union[str, Path, EgaitAdidas2014]], cv_iterator: Optional[Union[int, BaseCrossValidator, Iterator]] = GroupKFold(n_splits=5), cv_params: Optional[Dict] = None) None[source]#
get_core_results() ResultType[source]#

Get the main results of the challenge.

classmethod load_core_results(folder_path) ResultType[source]#

Load the core results from a folder that have been stored using save_core_results.

The assumption is, that the output is identical to calling get_core_results on the challenge instance directly.

When implementing this method, make sure that it remains compatible with results saved using older versions of the challenge_class.

run(optimizer: BaseOptimize)[source]#

Run the challenge.

save_core_results(folder_path) None[source]#

Save the main results of the challenge to a folder.