goml

Golang 机器学习：数据传输层面

goml 是一款完全由 Golang 编写的机器学习库，它让普通开发者能够轻松将机器学习功能集成到自己的应用程序中。（发音类似于数据格式“toml”）

虽然该库支持传统的批量学习接口，但 goml 还提供了多种模型，使您能够通过将数据传递至通道中所持有的流式数据，以在线、反应式的方式进行学习。

该库包含全面的测试、详尽的文档，以及简洁、富有表现力、模块化清晰的源代码。我们强烈鼓励社区成员积极贡献代码。

每个包（如下文所述）都附有单独的 README 文件，帮助您深入了解各模型的功能与用途。最重要的是，如果您想了解某个模型，请务必阅读该包的 GoDoc 参考文档。正如上文所述，所有模型均经过了详尽的文档化处理。

安装

go get github.com/cdipaolo/goml/base

# 如果您有其他需求，也可以使用任意其他模型包
#
# 此外，base 包早已被许多其他包所引入，因此您甚至无需显式地执行 `go get` 操作
go get github.com/cdipaolo/goml/perceptron

文档

所有代码均已充分注释，并且其源码如果想要彻底理解其中的逻辑，应该会非常易于阅读！只需查看各个包（例如当前在 GitHub 上的这些包），您就会看到指向 GoDoc 的链接，以及该包的说明和示例用法。您甚至可以点击下方的主要要点，直接跳转到相应的包页面。此外，您也可以直接使用本 README 顶部的 GoDoc 链接，快速导航至您想要深入了解的特定包。

下方的子要点则可直接带您前往相应模型的源代码。

目前已实现的模型

• 广义线性模型（全部支持随机生成算法、批量生成算法，以及在线学习选项，仅本地加权线性回归除外）
  • 普通最小二乘法
  • 本地加权线性回归
  • 逻辑回归
  • Softmax（多分类逻辑回归）
• 感知器仅提供在线学习选项
  • 在线二分类感知器
  • 在线二分类核感知器
• 聚类
  • K-means 聚类
    • 使用 k-means++ 初始化方法，以获得更可靠的聚类结果（这篇论文 讨论了该方法及其相较于常规随机初始化的优势）
    • 同时支持在线版本和批量版本
    • 还包含一个利用 三角不等式 的版本，通过大幅减少距离计算次数，同时牺牲部分辅助数据结构，具体细节请参阅 这篇论文）
  • K 近邻聚类
    • 可以使用任意距离度量，goml/base 包中已预定义了 L 范数、欧几里得距离以及曼哈顿距离等多种距离度量。
• 文本分类
  • 多项式（多分类）基于文本的朴素贝叶斯
  • 词频 - 逆文档频率
    • 该方法能够从文档中提取关键词或重要词汇
    • 由于其底层原理与贝叶斯算法极为相似，您可以将朴素贝叶斯模型转换为 TFIDF，从而构建出相应的模型。查看这些测试示例，即可一睹其应用效果

贡献！

请参阅 CONTRIBUTING。

如果您认为自己有意愿实现尚未收录的模型，或者对现有模型进行了优化改进，又或是希望协助完善文档（这一点真的非常值得感谢——相信我，撰写出色的文档需要耗费大量时间！ :+1:）

许可证 — MIT

请参阅 LICENSE。

goml 快速上手指南

goml 是一个完全用 Go 语言编写的机器学习库，旨在让普通开发者轻松将机器学习功能集成到应用中。它既支持传统的批量学习（Batch Learning），也支持基于 Channel 流的在线学习（Online Learning）。

环境准备

• 操作系统：Linux, macOS, Windows (支持 Go 运行的所有平台)
• Go 版本：建议安装 Go 1.16 或更高版本
• 前置依赖：无第三方外部依赖，仅需标准 Go 环境

国内加速建议： 在中国大陆地区，建议配置 Go 模块代理以加速下载：

export GOPROXY=https://goproxy.cn,direct
# 或者永久写入环境变量
go env -w GOPROXY=https://goproxy.cn,direct

安装步骤

使用 go get 命令安装基础包和你需要的具体模型包。以下以安装基础包和感知机（Perceptron）模型为例：

# 安装基础包（包含通用数据结构和接口）
go get github.com/cdipaolo/goml/base

# 安装具体的模型包（例如：感知机）
# 注意：许多模型包会自动导入 base 包，通常只需安装具体模型包即可
go get github.com/cdipaolo/goml/perceptron

如需使用其他模型（如线性回归、K-Means 等），将上述命令中的 perceptron 替换为对应的包名（如 linear, cluster, text）。

基本使用

goml 的核心设计理念是通过 Channel 进行数据流式处理。以下是一个最简单的在线二元感知机训练示例：

package main

import (
	"github.com/cdipaolo/goml/base"
	"github.com/cdipaolo/goml/perceptron"
)

func main() {
	// 1. 创建数据流通道
	// chan <- *base.DataPoint: 用于发送训练数据
	// <-chan error: 用于接收错误信息
	// <-chan *perceptron.Perceptron: 用于接收训练好的模型
	dataStream := make(chan *base.DataPoint)
	errStream := make(chan error)
	modelStream := make(chan *perceptron.Perceptron)

	// 2. 初始化模型
	// 参数说明：
	// - true: 开启在线学习模式
	// - 0.1: 学习率 (Learning Rate)
	// - dataStream, errStream, modelStream: 通信通道
	go perceptron.NewOnline(dataStream, errStream, modelStream, true, 0.1)

	// 3. 发送训练数据 (特征向量，标签)
	// 示例：发送一个二维特征 [1.0, 2.0]，标签为 1
	dataStream <- &base.DataPoint{
		X: []float64{1.0, 2.0},
		Y: 1,
	}
	
	// 发送更多数据...
	// dataStream <- &base.DataPoint{X: []float64{...}, Y: ...}

	// 4. 关闭数据通道以触发模型完成训练并输出
	close(dataStream)

	// 5. 接收结果或错误
	select {
	case err := <-errStream:
		if err != nil {
			panic(err)
		}
	case model := <-modelStream:
		// 获取训练好的模型
		// 使用 model.Predict() 进行预测
		println("模型训练完成！")
	}
}

关键点说明：

• 数据格式：训练数据通过 base.DataPoint 结构体传递，X 为特征切片，Y 为目标值。
• 并发模式：模型训练在独立的 Goroutine 中运行，通过 Channel 与主程序通信。
• 文档查阅：每个模型包（如 linear, cluster）都有详细的 Godoc 文档和示例代码，建议访问 Godoc 参考 查看具体模型的用法。