MLOps Coding Course 使用文档
1. 项目的目录结构及介绍
mlops-coding-course/
├── CODE_OF_CONDUCT.md
├── LICENSE.txt
├── README.md
├── invoke.yaml
├── mkdocs.yml
├── mlops-coding-course.code-workspace
├── poetry.lock
├── poetry.toml
├── pyproject.toml
├── tasks.py
├── docs/
│ └── ...
├── src/
│ └── ...
└── tests/
└── ...
- CODE_OF_CONDUCT.md: 行为准则文件。
- LICENSE.txt: 项目许可证文件。
- README.md: 项目介绍和使用说明。
- invoke.yaml: 任务配置文件。
- mkdocs.yml: 文档生成配置文件。
- mlops-coding-course.code-workspace: VS Code 工作区配置文件。
- poetry.lock: Poetry 依赖锁定文件。
- poetry.toml: Poetry 配置文件。
- pyproject.toml: 项目构建配置文件。
- tasks.py: 项目任务脚本。
- docs/: 项目文档目录。
- src/: 项目源代码目录。
- tests/: 项目测试代码目录。
2. 项目的启动文件介绍
项目的启动文件通常位于 src/
目录下,具体文件名取决于项目的结构。例如,如果项目的主入口文件是 main.py
,则路径为 src/main.py
。
# src/main.py
def main():
# 项目启动逻辑
pass
if __name__ == "__main__":
main()
3. 项目的配置文件介绍
- pyproject.toml: 包含了项目的构建系统和依赖管理配置。
- poetry.toml: 包含了 Poetry 的额外配置。
- mkdocs.yml: 用于生成项目文档的配置文件。
- invoke.yaml: 用于定义项目任务的配置文件。
pyproject.toml
[tool.poetry]
name = "mlops-coding-course"
version = "0.1.0"
description = "MLOps Coding Course"
authors = ["Your Name <you@example.com>"]
[tool.poetry.dependencies]
python = "^3.8"
[tool.poetry.dev-dependencies]
pytest = "^6.2"
[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"
mkdocs.yml
site_name: MLOps Coding Course
nav:
- Home: index.md
- Overview: overview.md
- Initializing: initializing.md
- Prototyping: prototyping.md
- Productionizing: productionizing.md
- Validating: validating.md
- Refining: refining.md
- Sharing: sharing.md
- Observability: observability.md
invoke.yaml
tasks:
- name: test
command: pytest
- name: build
command: poetry build
以上是 MLOps Coding Course 项目的基本使用文档,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。