fklearn：函数式机器学习

fklearn 借助函数式编程原则，使使用机器学习解决实际问题变得更加容易。

该名称参考了广为人知的 scikit-learn 库。

fklearn 原则

1. 验证应反映真实场景。
2. 生产环境中的模型应与验证过的模型一致。
3. 模型只需少量额外步骤即可直接投入生产。
4. 模型结果的可复现性和深入分析应易于实现。

文档 | 快速入门 | API 文档 | 贡献指南 |

安装

通过 pip 安装：

pip install fklearn

你也可以从源码安装：

git clone git@github.com:nubank/fklearn.git
cd fklearn
git checkout master
pip install -e .

许可证

Apache License 2.0

fklearn 快速上手指南

fklearn 是一个基于函数式编程原则构建的机器学习库，旨在简化真实场景下的机器学习问题解决流程。它强调验证环境与生产环境的一致性，确保模型可复现且易于分析。

环境准备

• 操作系统：支持 Linux、macOS 和 Windows
• Python 版本：建议 Python 3.7 及以上
• 前置依赖：
  • pip 包管理工具
  • 基础科学计算库（安装 fklearn 时会自动处理大部分依赖，如 pandas, numpy, scikit-learn 等）

提示：国内开发者建议使用国内镜像源加速安装过程，例如清华源或阿里源。

安装步骤

方式一：通过 pip 安装（推荐）

使用国内镜像源加速安装：

pip install fklearn -i https://pypi.tuna.tsinghua.edu.cn/simple

或使用阿里源：

pip install fklearn -i https://mirrors.aliyun.com/pypi/simple/

方式二：从源码安装

适用于需要最新开发版本或贡献代码的场景：

git clone git@github.com:nubank/fklearn.git
cd fklearn
git checkout master
pip install -e .

基本使用

fklearn 的核心设计理念是“函数式”，即每个步骤都是纯函数，输入数据框，输出转换后的数据框或模型对象。以下是一个最简单的分类任务示例：

from fklearn.training.classification import xgb_classifier
from fklearn.evaluation.classification import auc_evaluator
from fklearn.validation.validator import time_split_validator

# 1. 准备数据 (假设 df 是包含特征和目标列 'target' 的 pandas DataFrame)
# df = ...

# 2. 定义训练函数
train_fn = xgb_classifier(
    training_data=df,
    features=["feature1", "feature2"],
    target="target",
    prediction_column="prediction"
)

# 3. 获取训练好的模型和预测结果
trained_model, predictions, train_log = train_fn

# 4. 评估模型性能
eval_results = auc_evaluator(
    data=predictions,
    target_column="target",
    prediction_column="prediction"
)

print(eval_results)

上述示例展示了 fklearn 的典型工作流：定义训练函数 -> 执行训练 -> 评估结果。所有操作均保持数据不可变，便于追踪和复现。

更多详细用法请参考 官方文档。