TODS 项目教程

1. 项目的目录结构及介绍

TODS 项目的目录结构如下：

tods/
├── datasets/
│   └── ...
├── docs/
│   └── ...
├── examples/
│   └── ...
├── primitive_tests/
│   └── ...
├── tods/
│   └── ...
├── .coveralls.yml
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── README_zh-CN.md
└── setup.py

目录结构介绍

• datasets/: 包含项目使用的数据集。
• docs/: 包含项目的文档文件。
• examples/: 包含项目的示例代码。
• primitive_tests/: 包含项目的单元测试代码。
• tods/: 包含项目的主要代码文件。
• .coveralls.yml: Coveralls 配置文件。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目的英文介绍文件。
• README_zh-CN.md: 项目的中文介绍文件。
• setup.py: 项目的安装配置文件。

2. 项目的启动文件介绍

TODS 项目的启动文件主要是 setup.py 和 examples/ 目录下的示例代码文件。

setup.py

setup.py 是 Python 项目的标准安装文件，用于配置项目的安装选项。通过运行以下命令可以安装项目：

pip install -e .

示例代码文件

在 examples/ 目录下，你可以找到多个示例代码文件，这些文件展示了如何使用 TODS 进行时间序列异常检测。例如：

• examples/basic_usage.py: 展示了如何加载默认的管道并评估其在给定数据集上的表现。
• examples/automl_example.py: 展示了如何使用 AutoML 功能自动搜索最佳管道。

3. 项目的配置文件介绍

TODS 项目的配置文件主要包括 .coveralls.yml、.gitignore 和 .travis.yml。

.coveralls.yml

.coveralls.yml 是 Coveralls 的配置文件，用于配置代码覆盖率服务的相关选项。

.gitignore

.gitignore 文件用于指定 Git 应该忽略的文件和目录，避免将不必要的文件提交到版本控制系统中。

.travis.yml

.travis.yml 是 Travis CI 的配置文件，用于配置持续集成服务的相关选项。通过该文件，可以定义项目的构建、测试和部署流程。

---

以上是 TODS 项目的目录结构、启动文件和配置文件的介绍。通过这些内容，你可以更好地理解和使用 TODS 项目。