Goro 项目使用教程

1. 项目目录结构及介绍

Goro 是一个用 Go 语言编写的高级机器学习库，其目录结构如下：

goro/
├── examples/
│   └── mnist/
├── pkg/
│   └── v1/
├── static/
├── vendor/
├── .DS_Store
├── LICENSE
├── README.md
├── doc.go
├── go.mod
├── go.sum

目录结构介绍

• examples/: 包含项目的示例代码，例如 mnist 示例。
• pkg/v1/: 包含项目的核心代码，版本为 v1。
• static/: 可能包含静态资源文件。
• vendor/: 包含项目的依赖库。
• .DS_Store: macOS 系统文件，通常可以忽略。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍文档。
• doc.go: 项目的文档文件。
• go.mod: Go 模块文件，定义了项目的依赖。
• go.sum: Go 模块的校验和文件。

2. 项目启动文件介绍

Goro 项目的启动文件通常是 examples/mnist/main.go，这是一个示例文件，展示了如何使用 Goro 库来训练和预测 MNIST 数据集。

启动文件示例

package main

import (
    "github.com/aunum/goro/pkg/v1/model"
    "github.com/aunum/goro/pkg/v1/layer"
)

func main() {
    // 创建输入 'x'，表示 MNIST 图像
    x := model.NewInput("x", []int{1, 28, 28})

    // 创建输出 'y'，表示标签
    y := model.NewInput("y", []int{10})

    // 创建一个新的顺序模型，命名为 'mnist'
    mnistModel := model.NewSequential("mnist")

    // 添加层到模型中
    mnistModel.AddLayers(
        layer.Conv2D{Input: 1, Output: 32, Width: 3, Height: 3},
        layer.MaxPooling2D{},
        layer.Conv2D{Input: 32, Output: 64, Width: 3, Height: 3},
        layer.MaxPooling2D{},
        layer.Conv2D{Input: 64, Output: 128, Width: 3, Height: 3},
        layer.MaxPooling2D{},
        layer.Flatten{},
        layer.FC{Input: 128 * 3 * 3, Output: 100},
        layer.FC{Input: 100, Output: 10, Activation: layer.Softmax},
    )

    // 选择优化器
    optimizer := model.NewRMSPropSolver()

    // 编译模型
    mnistModel.Compile(x, y, model.WithOptimizer(optimizer), model.WithLoss(model.CrossEntropy), model.WithBatchSize(100))

    // 训练模型
    mnistModel.Fit(xTrain, yTrain)

    // 使用模型进行预测
    prediction := mnistModel.Predict(xTest)
}

3. 项目配置文件介绍

Goro 项目没有明确的配置文件，但可以通过 go.mod 文件来管理项目的依赖。

go.mod 文件示例

module github.com/aunum/goro

go 1.16

require (
    gorgonia.org/gorgonia v0.9.17
    gorgonia.org/tensor v0.9.17
)

配置文件介绍

• module: 定义了项目的模块名称。
• go: 定义了 Go 语言的版本。
• require: 列出了项目所需的依赖库及其版本。

通过 go.mod 文件，可以轻松管理项目的依赖关系，确保项目在不同环境中的一致性。