nbdev 项目教程
nbdevCreate delightful software with Jupyter Notebooks项目地址:https://gitcode.com/gh_mirrors/nb/nbdev
1. 项目的目录结构及介绍
nbdev 是一个基于 Jupyter 笔记本的开发平台,以下是其典型的目录结构:
nbdev/
├── nbs/
│ ├── 00_core.ipynb
│ ├── 01_utils.ipynb
│ └── ...
├── docs/
│ ├── _quarto.yml
│ ├── index.md
│ └── ...
├── nbdev/
│ ├── __init__.py
│ ├── core.py
│ ├── utils.py
│ └── ...
├── .gitignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── MANIFEST.in
├── README.md
├── settings.ini
├── setup.py
└── ...
目录结构介绍
- nbs/: 包含所有的 Jupyter 笔记本文件,这些文件用于编写和测试代码。
- docs/: 包含项目文档,使用 Quarto 生成。
- nbdev/: 包含从笔记本导出的 Python 模块。
- .gitignore: 指定 Git 忽略的文件和目录。
- CHANGELOG.md: 记录项目的变更日志。
- CODE_OF_CONDUCT.md: 项目的行为准则。
- CONTRIBUTING.md: 贡献指南。
- LICENSE: 项目的许可证。
- MANIFEST.in: 包含需要包含在发布包中的文件。
- README.md: 项目的主页说明。
- settings.ini: 项目的配置文件。
- setup.py: 用于安装项目的脚本。
2. 项目的启动文件介绍
nbdev 项目的启动文件通常是 nbs/
目录下的 Jupyter 笔记本文件。例如,00_core.ipynb
是项目的核心笔记本文件,包含了项目的主要功能和代码。
3. 项目的配置文件介绍
nbdev 项目的配置文件是 settings.ini
,它包含了项目的基本配置信息,例如版本号、作者、依赖库等。以下是一个示例配置文件的内容:
[DEFAULT]
version = 0.0.1
author = fastai
description = A notebook-driven development platform
keywords = nbdev, jupyter, notebook
copyright = fastai
license = apache2
配置文件介绍
- version: 项目的版本号。
- author: 项目的作者。
- description: 项目的简短描述。
- keywords: 项目的关键词。
- copyright: 项目的版权信息。
- license: 项目的许可证类型。
通过这些配置,nbdev 可以自动生成文档、测试、持续集成和打包等功能。
nbdevCreate delightful software with Jupyter Notebooks项目地址:https://gitcode.com/gh_mirrors/nb/nbdev