SmallPebble 项目教程

1. 项目目录结构及介绍

SmallPebble 是一个用 Python 编写的极简深度学习库，使用 NumPy/CuPy 进行自动微分和深度学习。以下是项目的目录结构及其介绍：

SmallPebble/
├── .gitignore
├── LICENSE
├── README.ipynb
├── README.md
├── TODO
├── build.py
├── pebbles.jpg
├── requirements-cupy.txt
├── requirements-test.txt
├── requirements.txt
├── setup.cfg
├── setup.py
├── smallpebble_2022-08-15.png
├── style-guide.md
└── smallpebble/
    └── smallpebble.py

目录结构介绍

• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件，采用 Apache-2.0 许可证。
• README.ipynb: Jupyter Notebook 格式的项目介绍文件。
• README.md: Markdown 格式的项目介绍文件。
• TODO: 项目待办事项列表。
• build.py: 构建脚本文件。
• pebbles.jpg: 项目相关图片。
• requirements-cupy.txt: 使用 CuPy 时的依赖文件。
• requirements-test.txt: 测试依赖文件。
• requirements.txt: 项目依赖文件。
• setup.cfg: 项目配置文件。
• setup.py: 项目安装脚本。
• smallpebble_2022-08-15.png: 项目相关图片。
• style-guide.md: 项目代码风格指南。
• smallpebble/: 项目核心代码目录。
  • smallpebble.py: 项目核心代码文件，包含了自动微分和深度学习的主要实现。

2. 项目启动文件介绍

SmallPebble 项目的启动文件是 smallpebble/smallpebble.py。这个文件包含了项目的核心功能，包括自动微分和深度学习的基本操作。

启动文件功能介绍

• 自动微分: 实现了自动微分的核心逻辑，支持前向和反向传播。
• 深度学习操作: 提供了常见的深度学习操作，如矩阵乘法、卷积、池化等。
• 模型构建: 支持通过简单的 API 构建深度学习模型。

3. 项目的配置文件介绍

SmallPebble 项目的配置文件主要包括 setup.cfg 和 requirements.txt。

setup.cfg

setup.cfg 是项目的配置文件，用于配置项目的安装和构建选项。以下是一个示例配置：

[metadata]
name = SmallPebble
version = 0.1
description = Minimal deep learning library written from scratch in Python using NumPy/CuPy
author = sradc
license = Apache-2.0

[options]
packages = find:
install_requires =
    numpy
    cupy

requirements.txt

requirements.txt 文件列出了项目运行所需的依赖包。以下是一个示例：

numpy
cupy

requirements-cupy.txt

requirements-cupy.txt 文件列出了使用 CuPy 时的额外依赖包。以下是一个示例：

cupy-cuda11x

requirements-test.txt

requirements-test.txt 文件列出了项目测试所需的依赖包。以下是一个示例：

pytest

通过这些配置文件，用户可以方便地安装和管理 SmallPebble 项目的依赖项，确保项目能够正常运行和测试。