# neural_net

**Repository Path**: youzimo/neural_net

## Basic Information

- **Project Name**: neural_net
- **Description**: 作为个人学习使用
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-06
- **Last Updated**: 2026-08-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# neural_net

#### 介绍

neural_net 是一个个人学习项目，旨在模仿 PyTorch 编写一个轻量级的 C++ 神经网络库。通过这个项目，学习者可以深入理解神经网络库底层实现原理，掌握张量运算、层模块化设计以及参数管理等核心概念。

**注意：该项目目前仍在开发中，尚未完善，暂不可用于生产环境。**

#### 软件架构

```
neural_net
├── LICENSE                   # 开源许可证
├── include/                  # 外部接口调用与符号
│   └── nn/                   # 项目命名空间
│       ├── modules/          # 常用模块（目前仅实现 Linear）
│       │   └── Linear.hpp        # 神经网络线性层实现
│       ├── optim/            # 优化器
│       │   ├── Optimizer.hpp     # 优化器抽象基类
│       │   └── SGD.hpp           # SGD 优化器
│       ├── functional.hpp    # 常用函数声明
│       ├── Tensor.hpp        # 张量类，多维数组核心数据结构
│       ├── Module.hpp        # 神经网络模型基类，模块化设计基础
│       ├── Sequential.hpp    # 神经网络序列类，用于快速搭建模型
│       ├── Parameter.hpp     # 神经网络参数类，管理可训练权重
│       ├── random_global.hpp # 全局随机数生成器
│       └── typedef.hpp       # 全局类型定义，确保类型一致性
├── src/                      # 项目具体实现
│   ├── functional.cpp        # 常用函数实现
│   ├── Tensor_core.cpp       # 张量类核心功能实现
│   ├── Tensor_ops.cpp        # 张量类简单算术运算实现
│   ├── Tensor_linalg.cpp     # 张量类代数运算实现
│   ├── Module.cpp            # 模块基类实现
│   ├── Sequential.cpp        # 序列类实现
│   ├── Linear.cpp            # 线性层实现
│   ├── SGD.cpp               # SGD 优化器实现
│   └── main.cpp              # 程序入口
└── makefile                  # 编译配置文件
```

#### 技术特性

- **命名空间管理**：所有代码封装在 `nn` 命名空间中，避免与其他库冲突
- **模块化设计**：基于 `Module` 基类构建，支持层的灵活组合
- **张量运算**：提供 `Tensor` 类作为多维数组数据结构的实现
- **参数管理**：`Parameter` 类专门用于管理神经网络中的可训练参数
- **随机初始化**：全局随机数生成器支持权重的随机初始化

#### 安装与编译

项目使用 Makefile 进行构建，请确保系统中已安装 C++ 编译器（支持 C++11 及以上标准）。

```bash
# 克隆项目
git clone <repository-url>
cd neural_net

# 编译项目
make

# 运行示例
build/nn
```

#### 目录说明

| 目录/文件 | 说明 |
|-----------|------|
| `include/nn/` | 头文件目录，包含所有对外接口声明 |
| `include/nn/layers/` | 神经网络层模块实现目录 |
| `include/nn/optim/` | 神经网络优化器实现目录 |
| `src/` | 源文件目录，包含具体实现逻辑 |
| `makefile` | 项目构建配置 |

#### 开发进度

- [x] 项目基础框架搭建
- [x] Tensor 张量类基本实现
- [x] Module 模块基类实现
- [x] Linear 线性层基础实现
- [X] 完善张量运算功能
- [X] 实现反向传播机制
- [X] 实现 Sequential
- [X] 添加用于训练的 Optimizer
- [ ] 添加更多神经网络层
- [ ] 优化性能和稳定性

#### 适用人群

本项目适合以下人群学习参考：
- 对深度学习框架底层实现感兴趣的开发者
- 希望了解 PyTorch 等框架设计原理的学习者
- 需要构建轻量级神经网络应用的场景（未来完善后）

#### 许可证

本项目遵循 LICENSE 文件中指定的开源协议。