---

Neuronika 是一个用纯 Rust 编写的机器学习框架，专注于易用性、快速原型开发和高性能。

将 Neuronika 添加到你的项目中

[dependencies]

neuronika = { git = "https://github.com/neuronika/neuronika" }

动态神经网络与自动微分

Neuronika 的核心机制是 反向模式自动微分，它允许你使用简洁、完全命令式的“按运行定义”API，以极低的开销定义动态变化的神经网络。

Rust 的强大之处

Rust 语言提供了直观、轻量且易于使用的接口，同时实现了惊人的性能。无需 FFI，一切都在你的掌控之中。

Crate 特性标志

• cuda 启用 GPU 加速的原语。

你可以使用以下 crate 特性标志来配置 ndarray 后端：

• serialize 启用对 serde 1.x 的序列化支持。

• blas 启用矩阵乘法的透明 BLAS 支持，该功能使用 blas-src 作为可插拔后端，需要单独配置。更多信息请参见 这里。

• matrixmultiply-threading 启用 matrixmultiply 包中的 threading 功能。

贡献

我们非常欢迎并感谢所有贡献。如果你计划提交 bug 修复，请直接提交，无需进一步讨论。

如果你打算贡献新功能、实用工具函数或框架扩展，请先发起讨论并与我们沟通。未经讨论就发送 PR 可能会导致被拒绝，因为我们可能正在将项目朝与你不同的方向推进。

要了解更多关于如何为 Neuronika 做出贡献的信息，请查看我们的 贡献页面。

获取帮助

首先，请查看 API 文档 是否能找到你的问题答案。如果文档中没有答案，请通过打开 讨论 提问寻求帮助。我们很乐意为你提供支持。

项目状态

Neuronika 还非常年轻，发展迅速。我们正在持续开发该项目，版本之间的过渡可能会出现破坏性变更。我们会根据需要采用最新的稳定版 Rust 特性。

许可证

双重许可，以兼容 Rust 项目。

可根据你的选择，依据 Apache License, Version 2.0 或 MIT 许可证 授予本文件的使用权。除上述条款外，本文件不得被复制、修改或分发。

Neuronika 快速上手指南

Neuronika 是一个用纯 Rust 编写的机器学习框架，专注于易用性、快速原型设计和高性能。它采用反向模式自动微分机制，支持通过简洁的命令式 API 定义动态神经网络。

环境准备

• 操作系统：支持 Linux、macOS 和 Windows。
• Rust 版本：建议使用最新稳定版 Rust (rustup update)。Neuronika 会积极采用 Rust 的最新稳定特性。
• 前置依赖：
  • 基础使用无需额外依赖。
  • 可选加速：若需启用 GPU 加速，需安装 CUDA 工具包并开启 cuda 特性；若需 BLAS 加速矩阵乘法，需配置 blas-src（详见特性说明）。

安装步骤

在项目的 Cargo.toml 文件中添加以下依赖。由于该项目目前主要通过 Git 仓库发布，推荐直接引用源码：

[dependencies]
neuronika = { git = "https://github.com/neuronika/neuronika" }

可选特性配置： 如需启用特定功能，可在依赖项中指定 features：

[dependencies]
# 示例：启用 CUDA GPU 加速和 Serde 序列化支持
neuronika = { git = "https://github.com/neuronika/neuronika", features = ["cuda", "serialize"] }

可用特性列表：

• cuda: 启用 GPU 加速原语。
• serialize: 启用 [serde] 1.x 序列化支持。
• blas: 启用透明 BLAS 支持（需单独配置后端）。
• matrixmultiply-threading: 启用矩阵乘法的多线程支持。

基本使用

Neuronika 的核心优势在于其“定义即运行”（define-by-run）的动态图机制。以下是一个最简单的张量运算与自动微分示例：

use neuronika::prelude::*;
use neuronika::tensor;

fn main() {
    // 创建需要计算梯度的张量
    let x = tensor![2.0, 3.0].requires_grad();
    
    // 定义简单的数学运算 (y = x^2 + 1)
    let y = &x * &x + 1.0;
    
    // 执行反向传播计算梯度
    y.backward();
    
    // 获取梯度值
    println!("梯度：{:?}", x.grad());
    // 输出预期：梯度：Some([4.0, 6.0])
}

使用说明：

1. 引入 neuronika::prelude::* 以使用核心特征。
2. 使用 tensor! 宏或相关构造函数创建张量，并通过 .requires_grad() 标记需要追踪梯度的变量。
3. 像编写普通 Rust 代码一样构建计算图。
4. 调用 .backward() 触发反向模式自动微分。
5. 通过 .grad() 访问计算出的梯度。

注意：Neuronika 目前处于快速迭代阶段，API 可能会随版本更新发生变化，建议锁定具体的 Git commit 或关注官方文档更新。