# Riemann **Repository Path**: xfcode2021/Riemann ## Basic Information - **Project Name**: Riemann - **Description**: Riemann是一个类似PyTorch的神经网络编程框架,支持张量计算中的自动求导,提供搭建神经网络所需的组件,为神经网络相关的学习、教育和研究目的而设计。 - **Primary Language**: Python - **License**: BSD-3-Clause - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 13 - **Forks**: 8 - **Created**: 2025-12-28 - **Last Updated**: 2026-11-19 ## Categories & Tags **Categories**: machine-learning **Tags**: 自动求导, 神经网络, 深度学习, PyTorch, Transformer ## README # Riemann **语言**: [中文](README_zh.md) | [English](README.md) Riemann是一个类似PyTorch的神经网络编程框架,支持张量计算中的自动求导,提供搭建神经网络所需的组件,为神经网络相关的学习、教育和研究目的而设计。 ## 功能介绍 ### 1. 张量计算及自动求导 - 支持0到多维张量的数学运算,支持复数张量运算,支持CUDA - 线性代数模块支持矩阵运算,包括:批量矩阵乘法、矩阵分解、特征值与行列式、矩阵逆与伪逆、线性方程组求解、范数与秩等 - 支持张量形状重塑、维度扩缩、索引和切片、元素收集/散射、拼接/分割等操作 - 支持基于反向传播算法的自动梯度跟踪,支持函数对输入求导,支持用户自定义梯度函数 - 支持张量序列化/反序列化,方便模型训练和部署 ### 2. 神经网络模块 - 基本层(Linear, Dropout, BatchNorm, LayerNorm, Embedding等) - 激活函数(ReLU, Sigmoid, Softmax等) - 损失函数(MSE, CrossEntropy等) - 卷积池化层(Conv1d/2d/3d, MaxPool1d/2d/3d, AvgPool1d/2d/3d等) - KAN网络(KANLinear, KAN) - Transformer(MultiheadAttention, TransformerEncoder, TransformerDecoder, Transformer等) - 优化器(SGD, Adam, Adagrad, LBFGS等) - 网络模块容器(Sequential, ModuleList, ModuleDict等) ## 应用场景 - **深度学习研究**:自定义模型和算法开发 - **科学计算**:复杂数学模型的梯度计算,优化问题求解 - **计算机视觉**:图像分类等视觉任务 - **教育教学**:自动求导和深度学习原理学习 ## PyTorch接口兼容性 Riemann库设计时注重与PyTorch接口的兼容性,同名的函数和类接口保持一致,方便PyTorch用户快速上手: - **张量操作**:支持与PyTorch同名的张量操作函数和方法,如`tensor()`、`grad()`、`backward()`等 - **神经网络组件**:`nn`模块中的层、激活函数和损失函数与PyTorch保持接口兼容 - **优化器**:`optim`模块中的优化器(如SGD、Adam等)接口与PyTorch保持一致 - **自动求导机制**:`requires_grad`、反向传播机制与PyTorch相似 - **torch.func兼容**:顶层 ``func`` 模块对齐 `torch.func` 接口——柯里化的 ``grad``、``jacrev``/``jacfwd``、``jvp``/``vjp``、``hessian``、``vmap``、``functional_call`` - **计算机视觉**:`vision`模块中的数据集和变换与torchvision保持接口兼容 - **跨框架互操作**:Riemann 张量可与 NumPy 数组、CuPy 数组以及 PyTorch 等其它张量框架互相转换或共享数据,入口包括 `r.tensor()`、`r.as_tensor()`、`r.from_dlpack()`、`TN.array()`、`TN.numpy()`,底层依托 `__array__`、`__cuda_array_interface__`、`__dlpack__`、`__buffer__` 协议;设备与 dtype 一致时为零拷贝 这种设计使得熟悉PyTorch的用户可以轻松迁移到Riemann库进行开发工作。 ## 项目文件夹结构 ``` Riemann/ ├── src/ │ └── riemann/ # 核心源代码 │ ├── autograd/ # 自动求导相关模块 │ ├── core/ # 核心张量子包(张量定义、函数式运算、数据类型、梯度模式、序列化) │ │ ├── __init__.py # core 子包聚合导出 │ │ ├── tensordef.py # 张量定义(TN 类)、动态计算图与自动微分 │ │ ├── tensorfuncs.py # 函数式张量运算(仅单向依赖 tensordef) │ │ ├── dtype.py # 数据类型定义 │ │ ├── ad_context.py # AD 上下文控制 │ │ └── serialization.py # 对象保存与加载 │ ├── nn/ # 神经网络模块 │ ├── optim/ # 优化器模块 │ ├── utils/ # 工具函数 │ ├── vision/ # 计算机视觉模块 │ ├── __init__.py # 包配置文件 │ ├── cuda.py # CUDA/GPU 支持 │ ├── func.py # 函数式自动求导接口 │ └── linalg.py # 线性代数函数 ├── data/ # 训练测试数据集文件目录 ├── docs/ # 项目文档目录 ├── tests/ # 测试文件 ├── examples/ # 示例代码 │ ├── backward_demo.py # 反向传播示例 │ ├── grad_demo.py # 梯度计算示例 │ ├── custom_grad_decorator.py # 自定义梯度跟踪函数示例 │ ├── optimizers_comparison.py # 优化器比较示例 │ ├── mnist_demo.py # MNIST手写数字识别GUI示例 │ ├── nn_MNIST_CE_SGD.py # 神经网络训练示例 │ ├── cnn_CIFAR10_CE_SGD.py # 卷积网络训练示例 │ └── ... ├── README.md # 项目文档 ├── LICENSE # 许可证文件 └── pyproject.toml # 项目配置和依赖管理 ``` ### 代码目录 代码目录 `src/riemann/` 是Riemann库的核心源代码所在地,包含了所有主要功能模块: - **autograd/**: 实现自动求导功能,包括反向传播算法和梯度计算 - **core/**: 核心张量子包,统一对外暴露张量 API - `tensordef.py`: 张量定义(TN 类)、动态计算图与自动微分 - `tensorfuncs.py`: 函数式张量运算(三角函数、索引选择、随机数、einsum 等),仅单向依赖 `tensordef.py` - `dtype.py`: 数据类型定义 - `ad_context.py`: AD 上下文控制 - `serialization.py`: 对象保存与加载 - **nn/**: 神经网络相关组件,如各种层、激活函数和损失函数 - **optim/**: 优化器模块,如SGD、Adam等优化器,以及学习率调度器 - **utils/**: 工具函数,包括数据集Dataset类和数据加载器Dataloader类等 - **vision/**: 计算机视觉相关功能,包括数据集和图像变换 - **`func`**: 函数式自动求导接口,参考 torch.func 设计。提供柯里化的纯函数式 API,如 ``grad``、``jvp``、``vjp``、``jacrev``、``jacfwd``、``hessian``、``hvp``、``vmap``、``functional_call``,适合链式高阶求导 - **核心文件**: 如 `linalg.py`(线性代数)、`cuda.py`(GPU 支持)等 ### tests目录 `tests/` 目录包含了大量测试用例,用于验证Riemann库的各种功能是否正常工作: - 测试用例按模块分类,覆盖了自动求导、张量操作、神经网络等各个功能模块 - 测试用例既可以使用pytest批量运行,也可以作为独立脚本单独运行 - 提供了详细的测试覆盖,确保库的稳定性和可靠性 ### 文档docs目录 `docs/` 目录用于存放项目文档: - 包含详细的API文档 - 提供使用指南和教程 - 记录项目架构和设计决策 - 帮助用户和开发者更好地理解和使用Riemann库 ### examples目录 `examples/` 目录包含了各种示例代码,展示如何使用Riemann库的不同功能: - **backward_demo.py**: backward函数使用演示 - **grad_demo.py**: grad函数使用演示 - **hessian.py**: 海森矩阵计算示例 - **jacobian.py**: 雅可比矩阵计算示例 - **gradient_clipping_demo.py**: 梯度裁剪示例 - **custom_grad_decorator.py**: 使用@track_grad装饰器自定义梯度跟踪函数示例 - **custom_grad_FunctionClass.py**: 使用Function类自定义梯度跟踪函数示例 - **scatter.py**: 张量散射操作示例 - **optimizers_comparison.py**: 优化器性能比较 - **nn_lr_scheduler.py**: 学习率调度器使用示例 - **nn_MNIST_CE_SGD.py**: MNIST手写数字识别(交叉熵 + SGD) - **nn_MNIST_CE_Adam.py**: MNIST手写数字识别(交叉熵 + Adam) - **nn_MNIST_CE_Adagrad.py**: MNIST手写数字识别(交叉熵 + Adagrad) - **nn_MNIST_MSE_GD.py**: MNIST手写数字识别(均方误差 + 梯度下降) - **nn_MNIST_MSE_SGD.py**: MNIST手写数字识别(均方误差 + SGD) - **nn_MNIST_MSE_LBFGS.py**: MNIST手写数字识别(均方误差 + LBFGS) - **cnn_CIFAR10_CE_SGD.py**: CIFAR10图像分类卷积网络(交叉熵 + SGD) - **cnn_CIFAR10_CE_Adam.py**: CIFAR10图像分类卷积网络(交叉熵 + Adam) - **kan_mnist.py**: KAN网络MNIST分类示例 - **transformer_timeseq.py**: Transformer时间序列预测示例 - **mnist_demo.py**: MNIST手写数字识别GUI应用 ## 安装方法 Riemann 尚未发布到 PyPI,**无法**通过 `pip install riemann` 安装,请从源码安装。 **Python版本**: Riemann 要求 Python >= 3.9,支持 Python 3.9 ~ 3.14。 ### 依赖一览 | 类别 | 依赖 | 说明 | |------|------|------| | 基础依赖 | numpy>=1.20.0、pillow>=8.0.0、tqdm>=4.0.0 | 运行 Riemann 必需 | | 测试依赖 | pytest>=7.0.0、torch>=2.0.0、torchvision>=0.15.0 | 仅运行测试时需要 | | CUDA依赖 | cupy-cuda12x(默认)、cupy-cuda13x、cupy-cuda11x、cupy-cuda10x | 仅 NVIDIA GPU 加速时需要 | ### 源码安装 ```bash git clone https://gitee.com/xfcode2021/Riemann.git cd Riemann # 基础安装(-e 为可编辑模式,修改代码后无需重装) pip install -e . # 可选:测试依赖 pip install -e .[tests] # 可选:CUDA 依赖(默认 CUDA 12.x,也可指定 cuda13 / cuda11 / cuda10) pip install -e .[cuda] ``` ### 手动安装依赖 若 pip/conda 因网络或依赖解析失败,可手动逐个安装: ```bash # 基础依赖 pip install numpy pillow tqdm # 测试依赖 pip install pytest torch torchvision # CUDA 依赖(按 nvcc --version 显示的版本选择) pip install cupy-cuda12x ``` - 系统环境可用操作系统包管理器安装(如 `apt install python3-numpy`、`brew install numpy`);**自建虚拟环境只能用 pip 安装**; - torch 请按 [PyTorch 官网](https://pytorch.org/get-started/locally/) 给出的命令单独安装; - Conda 环境可用 `conda create -n riemann python=3.10` 创建,但 CuPy 仍建议用 pip 安装。 装好依赖后执行 `pip install -e . --no-deps` 完成 Riemann 本体安装。 ### CUDA 依赖与平台兼容性 CUDA 依赖不会自动安装,需用 `pip install -e .[cuda]` 显式安装,并保证已装对应版本的 NVIDIA 驱动。 | 平台 | 架构 | CUDA支持 | 说明 | |------|------|----------|------| | Linux | x86_64/AMD64 | ✅ 支持 | 用 `pip install cupy-cudaXX` | | Windows | x86_64/AMD64 | ✅ 支持 | 用 `pip install cupy-cudaXX` | | macOS | x86_64/ARM64 | ❌ 不支持 | 无 NVIDIA 驱动,自动使用 CPU 模式 | | Linux (ARM64) | aarch64/arm64 | ⚠️ 需源码编译 | NVIDIA Jetson 等需从源码编译 CuPy | | Windows (ARM64) | aarch64/arm64 | ❌ 不支持 | 暂不支持 CUDA | ### CUDA 驱动安装 1. 运行 `nvcc --version` 查看已安装的 CUDA Toolkit 版本(`nvidia-smi` 显示的是驱动支持的最高版本,不等于已安装版本)。 2. 从 [CUDA Toolkit Archive](https://developer.nvidia.com/cuda-toolkit-archive) 下载并安装匹配版本的驱动/工具包。 3. 重启后再次运行 `nvcc --version` 确认版本。 ### 验证安装 安装完成后,可以运行以下代码验证: ```python import riemann as r print("CUDA可用:", r.cuda.is_available()) print("使用设备:", r.device('cuda' if r.cuda.is_available() else 'cpu')) ``` 如果CUDA安装成功,会显示`CUDA可用: True`,否则会显示`CUDA可用: False`并自动使用CPU模式。 ## 使用方法 ### 详细文档说明 Riemann的详细使用指南已在线发布: - **中文文档**: https://riemann-zh.readthedocs.io/zh-cn/latest/ - **英文文档**: https://riemann-en.readthedocs.io/en/latest/ 文档源文件位于`docs`目录,采用reStructuredText格式编写。本地构建 HTML 文档: **Windows:** ```batch cd docs make.bat html-all REM 同时构建英文和中文 make.bat html-en REM 仅构建英文 make.bat html-zh REM 仅构建中文 make.bat clean-all REM 清理构建产物 ``` **Linux / macOS:** ```bash cd docs chmod +x make.sh # 首次使用需赋予执行权限 ./make.sh html-all # 同时构建英文和中文 ./make.sh html-en # 仅构建英文 ./make.sh html-zh # 仅构建中文 ./make.sh clean-all # 清理构建产物 ``` ### riemann包的模块结构 ``` riemann # 主包 ├── autograd # 自动求导模块 │ └── functional # 自动求导函数式接口 ├── func # torch.func 风格函数式自动求导 API ├── linalg # 线性代数模块 ├── nn # 神经网络模块 │ └── functional # 神经网络函数 ├── optim # 优化器模块 │ └── lr_scheduler # 学习率调度器模块 ├── utils # 工具函数模块 │ └── data # 数据处理工具 ├── vision # 计算机视觉模块 │ ├── datasets # 数据集类 │ └── transforms # 图像变换操作 └── cuda # CUDA/GPU支持 ``` ### 模块导入示例 **整体导入riemann模块:** ```python import riemann as r # 使用张量创建函数 t = r.tensor([1.0, 2.0, 3.0]) # 使用自动求导功能 x = r.tensor([1.0, 2.0], requires_grad=True) y = x ** 2 y.sum().backward() print(x.grad) # 输出: [2. 4.] ``` **按模块树导入需要的函数和类:** ```python # 导入张量相关功能 from riemann import tensor, zeros, ones, randn # 导入自动求导功能 from riemann.autograd import grad, backward from riemann.autograd.functional import jacobian, hessian # 导入函数式自动求导 API(torch.func 风格,柯里化,支持高阶求导) from riemann import func from riemann.func import grad as fgrad, jvp, vjp, jacrev, jacfwd, hessian, hvp, vmap, functional_call # 导入线性代数功能 from riemann import linalg from riemann.linalg import svd, det, inv # 导入神经网络组件 from riemann.nn import Linear, Conv2d, ReLU, CrossEntropyLoss from riemann.nn.functional import relu, cross_entropy # 导入优化器 from riemann.optim import SGD, Adam, Adagrad # 导入计算机视觉功能 from riemann.vision.datasets import MNIST, CIFAR10 from riemann.vision.transforms import Compose, ToTensor, Normalize, RandomHorizontalFlip # 导入CUDA支持 from riemann import cuda from riemann.cuda import is_available, Device ``` ### 例1:求导数(梯度)示例 ```python # 例1:求导数(梯度)示例 # 本示例展示了两种计算梯度的方法: # 1. 使用grad函数直接计算函数相对于输入的梯度 # 2. 使用backward方法通过反向传播计算梯度 # 导入riemann库 from riemann import tensor from riemann.autograd import grad # 创建张量 t = tensor([1.0, 2.0, 3.0], requires_grad=True) # 定义函数 def f(x): return (x ** 2.0).sum() # 计算梯度 output = f(t) grad_f = grad(output, t)[0] print("梯度:", grad_f) # 输出: 梯度: [2. 4. 6.] # 反向传播示例 x = tensor([1.0, 2.0], requires_grad=True) y = tensor([3.0, 4.0], requires_grad=True) z = (x * y).sum() z.backward() print("x的梯度:", x.grad) # 输出: x的梯度: [3. 4.] print("y的梯度:", y.grad) # 输出: y的梯度: [1. 2.] ``` ### 例2:计算雅可比矩阵示例 ```python # 例2:计算雅可比矩阵示例 # 本示例展示了如何使用jacobian函数计算函数相对于输入的雅可比矩阵 # 雅可比矩阵是函数输出对输入的偏导数矩阵,对于多输入多输出函数非常重要 from riemann import tensor from riemann.autograd.functional import jacobian # 定义函数 def f(x): return x ** 2.0 # 创建输入张量 x = tensor([1.0, 2.0, 3.0], requires_grad=True) # 计算雅可比矩阵 jacob = jacobian(f, x) print("雅可比矩阵:", jacob) ``` ### 例3:简单神经网络训练示例 ```python # 例3:简单神经网络训练示例 # 本示例展示了如何训练一个简单的神经网络(线性回归模型)来求两数之和 # 包括模型创建、损失函数定义、优化器配置、训练循环和预测过程 # 神经网络训练示例:训练一个网络用于求两数之和,这个网络模型本质上是一个线性回归 from riemann import tensor from riemann.nn import Linear, MSELoss from riemann.optim import SGD # 创建模型 model = Linear(2, 1) criterion = MSELoss() optimizer = SGD(model.parameters(), lr=0.01) # 训练数据 inputs = tensor([[1.0, 2.0], [3.0, 4.0]]) targets = tensor([[3.0], [7.0]]) # 训练循环 for epoch in range(100): # 前向传播 outputs = model(inputs) loss = criterion(outputs, targets) # 反向传播和优化 optimizer.zero_grad() loss.backward() optimizer.step() if (epoch + 1) % 10 == 0: print(f'Epoch [{epoch+1}/100], Loss: {loss.item()}') # 预测 new_input = tensor([[5.0, 6.0]]) prediction = model(new_input) print(f'预测结果: {prediction.item()}') ``` ### 例4:简单卷积神经网络训练示例 ```python # 例4:简单卷积神经网络训练示例 # 本示例展示了如何使用卷积神经网络(CNN)训练CIFAR10图像分类模型 # 包括模型定义、数据加载与预处理、训练循环、模型评估和单个样本推理 import riemann as r from riemann.vision.datasets import CIFAR10 from riemann.vision.transforms import * from riemann.nn import * from riemann.optim import SGD from tqdm import tqdm # 加载数据 # 训练集使用数据增强,测试集不使用 train_transform = Compose([ RandomHorizontalFlip(), # 随机水平翻转 ToTensor(), Normalize((0.5279, 0.5303, 0.5373), (0.2739, 0.2728, 0.2625)) # CIFAR10实际标准化参数 ]) test_transform = Compose([ ToTensor(), Normalize((0.5279, 0.5303, 0.5373), (0.2739, 0.2728, 0.2625)) # CIFAR10实际标准化参数 ]) train_dataset = CIFAR10(root='data', train=True, transform=train_transform, download=True) test_dataset = CIFAR10(root='data', train=False, transform=test_transform, download=True) # 减小批次大小和数据量以加快测试 train_loader = r.utils.DataLoader(train_dataset, batch_size=100, shuffle=True) test_loader = r.utils.DataLoader(test_dataset, batch_size=1, shuffle=False) # 创建模型、损失函数和优化器 model = Sequential( Conv2d(3, 16, kernel_size=3, padding=1), ReLU(), MaxPool2d(kernel_size=2, stride=2), Flatten(), Linear(16 * 16 * 16, 10) ) criterion = CrossEntropyLoss() optimizer = SGD(model.parameters(), lr=0.01) # 训练循环 for epoch in range(3): # 训练3代 total_loss = 0 # 使用tqdm显示进度条 progress_bar = tqdm(train_loader, desc=f"Epoch {epoch+1}/3") for batch_idx, (data, target) in enumerate(progress_bar): # 前向传播 output = model(data) loss = criterion(output, target) # 计算输出与目标标签间的损失 # 反向传播和优化器更新 optimizer.zero_grad() # 清空训练参数的梯度 loss.backward() # 计算loss对训练参数的梯度 optimizer.step() # 更新训练参数 total_loss += loss.item() # 更新进度条显示当前损失 progress_bar.set_postfix({"Loss": f"{loss.item():.4f}"}) avg_loss = total_loss/len(train_loader) print(f"Epoch {epoch+1}, Average Loss: {avg_loss:.4f}") # 模型评估(推理测试) model.eval() # 设置为评估模式 correct = 0 total = 0 # 使用tqdm显示测试进度 test_progress_bar = tqdm(test_loader, desc="Testing") with r.no_grad(): # 禁用梯度计算 for data, target in test_progress_bar: # 前向传播 outputs = model(data) # 获取预测结果 predicted = outputs.argmax(dim=1) # 获取每个样本的预测类别 total += target.size(0) # 累加测试样本数 correct += (predicted == target).sum().item() # 累加正确预测的样本数 # 更新进度条显示当前准确率 current_accuracy = 100 * correct / total test_progress_bar.set_postfix({"Accuracy": f"{current_accuracy:.2f}%"}) # 输出最终测试准确率 test_accuracy = 100 * correct / total print(f"测试集准确率: {test_accuracy:.2f}% ({correct}/{total})") # 单个样本推理示例 sample_data, sample_target = next(iter(test_loader)) sample_output = model(sample_data[:1]) # 只取第一个样本 predicted_class = sample_output.argmax(dim=1) print(f"样本预测类别: {predicted_class.item()}, 实际类别: {sample_target[0].item()}") print("CNN训练和推理测试完成!") ``` ### 例5:GPU加速示例 ```python # 例5:GPU加速示例 # 本示例展示了如何在Riemann中使用GPU加速神经网络训练 # 包括设备检测与设置、模型和数据的设备迁移、GPU上的训练和评估过程 import riemann as r from riemann.nn import Linear, Flatten, ReLU, Sequential, CrossEntropyLoss from riemann.optim import Adam from riemann.vision.datasets import MNIST from riemann.vision.transforms import Compose, ToTensor, Normalize from tqdm import tqdm # 检查CUDA是否可用 device = r.device('cuda' if r.cuda.is_available() else 'cpu') print(f"使用设备: {device}") # 加载MNIST数据集 transform = Compose([ ToTensor(), Normalize((0.1307,), (0.3081,)) ]) train_dataset = MNIST(root='data', train=True, transform=transform, download=True) test_dataset = MNIST(root='data', train=False, transform=transform, download=True) train_loader = r.utils.DataLoader(train_dataset, batch_size=128, shuffle=True) test_loader = r.utils.DataLoader(test_dataset, batch_size=1, shuffle=False) # 创建模型并移动到指定设备 model = Sequential( Flatten(), Linear(28*28, 128), ReLU(), Linear(128, 10) ) model.to(device) criterion = CrossEntropyLoss() optimizer = Adam(model.parameters(), lr=0.001) # 训练循环 num_epochs = 5 for epoch in range(num_epochs): model.train() total_loss = 0 progress_bar = tqdm(train_loader, desc=f"Epoch {epoch+1}/{num_epochs}") for batch_idx, (data, target) in enumerate(progress_bar): # 将数据移动到指定设备 data, target = data.to(device), target.to(device) # 前向传播 output = model(data) loss = criterion(output, target) # 反向传播和优化 optimizer.zero_grad() loss.backward() optimizer.step() total_loss += loss.item() progress_bar.set_postfix({"Loss": f"{loss.item():.4f}"}) avg_loss = total_loss / len(train_loader) print(f"Epoch {epoch+1}, Average Loss: {avg_loss:.4f}") # 模型评估 model.eval() correct = 0 total = 0 with r.no_grad(): test_progress_bar = tqdm(test_loader, desc="Testing") for data, target in test_progress_bar: # 将数据移动到指定设备 data, target = data.to(device), target.to(device) # 前向传播 outputs = model(data) # 获取预测结果 predicted = outputs.argmax(dim=1) total += target.size(0) correct += (predicted == target).sum().item() current_accuracy = 100 * correct / total test_progress_bar.set_postfix({"Accuracy": f"{current_accuracy:.2f}%"}) # 输出最终测试准确率 test_accuracy = 100 * correct / total print(f"测试集准确率: {test_accuracy:.2f}% ({correct}/{total})") ``` ## 测试方法 Riemann项目文件夹中tests目录下包括覆盖所有功能的测试用例,这些测试用例既可以用pytest批量运行,也可以作独立脚本运行。 ### 使用pytest批量运行测试 您可以使用以下命令批量运行所有测试: ```bash # 运行tests目录下所有测试文件 pytest tests # 运行特定测试文件 pytest tests/test_008_autograd.py # 运行特定测试类或方法 pytest tests/test_008_autograd.py::TestAutograd::test_jacobian # 运行测试并生成覆盖率报告 pytest --cov=riemann tests/ # 运行vision模块测试 pytest tests/test_052_vision.py ``` ### 单独运行测试脚本 您也可以单独运行测试脚本: ```bash cd tests python test_008_autograd.py # 运行其他测试脚本 ``` ## 第三方依赖及许可证 ### 核心依赖 | 库 | 版本要求 | 许可证类型 | 说明 | |-----------|-----------|--------------|----------------------------| | NumPy | >=1.20.0 | BSD 3-Clause | 核心数值计算库 | | Pillow | >=8.0.0 | BSD 3-Clause | 图像处理库 | | tqdm | >=4.0.0 | MIT | 训练和数据加载进度条 | ### 测试依赖 | 库 | 版本要求 | 用途 | 许可证类型 | 说明 | |-------------|-----------|----------------|--------------|------------------------------| | PyTorch | >=2.0.0 | 结果对比 | BSD 3-Clause | 用于验证计算结果正确性 | | torchvision | >=0.15.0 | 计算机视觉 | BSD 3-Clause | PyTorch 的计算机视觉库 | | pytest | >=7.0.0 | 测试框架 | MIT | 用于组织和运行测试 | ### CUDA可选依赖 | 库 | 版本要求 | 用途 | 许可证类型 | 说明 | |---------------|----------|----------------|------------|------------------------------------------| | cupy-cuda13x | Latest | GPU 加速 | MIT | CUDA 13.x,支持 Linux/Windows x86_64 | | cupy-cuda12x | Latest | GPU 加速 | MIT | CUDA 12.x,支持 Linux/Windows x86_64 | | cupy-cuda11x | Latest | GPU 加速 | MIT | CUDA 11.x,支持 Linux/Windows x86_64 | | cupy-cuda10x | Latest | GPU 加速 | MIT | CUDA 10.x,仅支持 Linux x86_64 | *注:本项目还使用了 Python 标准库中的组件(如 unittest)进行测试,无需单独安装。* *注:NumPy、PyTorch 和 Pillow 的 BSD 3-Clause 许可证详情可查阅其官方网站。* ## 许可证 本项目采用BSD 3-Clause许可证。详见LICENSE文件。 ## 贡献指南 欢迎提交Issue和Pull Request!在贡献代码前,请确保所有贡献都符合项目的编码标准,并通过所有测试。 ## 联系方式 作者: 项飞 Github: https://github.com/xiangfei2017 Gitee: https://gitee.com/xfcode2021