TensorPool 使用教程

1. 项目目录结构及介绍

TensorPool 是一个简化 GPU 使用流程的开源项目，其目录结构如下：

tensorpool/
├── docs/              # 项目文档
├── examples/          # 使用示例
├── src/               # 项目源代码
├── .gitignore         # Git 忽略文件
├── LICENSE            # 项目许可证
├── README.md          # 项目说明文件
├── pyproject.toml     # Python 项目配置文件
└── uv.lock            # 系统锁文件

• docs/：包含项目的文档和开发者的说明。
• examples/：提供了一些如何使用 TensorPool 的示例。
• src/：存放了 TensorPool 的主要代码。
• .gitignore：指定 Git 在执行提交操作时应忽略的文件。
• LICENSE：包含了 TensorPool 遵循的开源协议。
• README.md：对项目进行了简要介绍，并包含了基本的使用说明。
• pyproject.toml：Python 项目配置文件，用于定义项目的元数据和依赖。
• uv.lock：系统锁文件，通常用于多线程或多进程操作。

2. 项目的启动文件介绍

TensorPool 的启动主要依赖于 CLI（命令行界面），其中 tp 是主要的启动命令。以下是一些常用的启动命令：

• tp init：创建一个新的 TensorPool 配置文件。
• tp init <prompt>：根据自然语言提示自动生成一个 TensorPool 配置文件。
• tp run <config_file>：执行一个配置文件定义的作业。
• tp listen <job_id>：实时查看作业输出。
• tp pull <job_id> [files...]：下载作业的输出文件。
• tp cancel <job_id(s)>：取消一个或多个正在运行的作业。
• tp dashboard：查看所有作业及其输出。

3. 项目的配置文件介绍

TensorPool 的配置文件通常以 tp.config.toml 的形式存在，它是作业配置的核心。以下是配置文件的一些基本组成部分：

[commands]
- "pip install -r requirements.txt"
- "python main.py --epochs 100"

[optimization_priority]
"PRICE"

[ignore]
".git"
".DS_Store"

[gpu]
"T4"

• commands：定义了在作业执行时需要运行的命令列表。
• optimization_priority：指定作业的优化优先级，可以是 "PRICE"（价格优先）或 "TIME"（时间优先）。
• ignore：列出在发送项目到云端时应该忽略的文件。
• gpu：指定要使用的 GPU 类型，可以是 "auto"（自动选择最佳 GPU）或其他特定的 GPU 类型。

通过修改 tp.config.toml 文件，用户可以调整作业的行为，以满足特定的需求。