疯狂的数据集

帮助访问 MaD-Lab 的开源步态数据集（未来可能还有外部数据集）。

这个包的目的是确保所有数据集都可以以类似的方式加载，并且所有数据（和注释）都采用相同的格式（即相同的传感器方向、单位等）。这应该允许在多个数据集上轻松运行相同的算法。

:warning: 虽然这样可以更轻松地使用数据集，但数据集提供的坐标系和其他数据信息可能与使用此库时获得的格式不匹配！

所有数据集 API 都是使用该 tpcp.Dataset 接口构建的。有关可用数据集，请参见下表。

用法

从 Pip 安装包

pip install mad-datasets

然后下载/获取您计划使用的数据集（见下文）。最好的入门方法是在文档页面上查看相应数据集的示例 。

数据集

注：sensor_position_comparison2019年记录的数据集不属于mad-datasets包，但可以使用 sensor_position_dataset_helperpython包以类似格式获取。

测试

该/tests目录包含一组测试来检查库的功能。但是，大多数测试依赖于库外某些文件夹中是否存在相应的数据集。因此，测试只能在本地运行，不能在 CI 服务器上运行。

要在本地运行它们，请确保将数据集下载到正确的文件夹中，然后运行poe test​​.

文档（构建说明）

与测试一样，文档要求将数据集下载到正确的文件夹中以执行示例。因此，我们不能在 RTD 上自动构建文档。相反，我们通过 github 页面托管文档。HTML 源代码可以在gh-pages这个 repo 的分支中找到。

为了使部署尽可能简单，我们将gh-pages分支“挂载”为docs/_build/html 文件夹中的子模块。因此，在您尝试构建文档之前，您需要初始化子模块。

git submodule update --init --recursive

之后，您可以运行poe docs以构建文档，然后poe upload_docs将更改推送到 gh-pages 分支。我们将始终只更新 gh-pages 分支上的单个提交以保持有效文件大小较小。

**警告：** 不要docs/_build手动删除文件夹或运行 sphinx make 文件！这将删除子模块并可能导致问题。该poe任务配置为docs/_build在每次运行之前清理文件夹中的所有相关文件。

更新文档后，您将看到您还需要在主 repo 中进行提交，因为 docs 子模块的提交哈希已更改。

为确保您不会忘记更新文档，该poe prepare_release任务还将自动构建和上传文档。