.. -- mode: rst --

|readthedocs| |github-actions| |Codecov| |PyPI| |Black|

.. |readthedocs| image:: https://readthedocs.org/projects/skops/badge/?version=latest&style=flat :target: https://skops.readthedocs.io/en/latest/ :alt: 文档

.. |github-actions| image:: https://github.com/skops-dev/skops/workflows/pytest/badge.svg :target: https://github.com/skops-dev/skops/actions :alt: Linux、macOS、Windows 测试

.. |Codecov| image:: https://codecov.io/gh/skops-dev/skops/branch/main/graph/badge.svg :target: https://codecov.io/gh/skops-dev/skops :alt: Codecov

.. |PyPI| image:: https://img.shields.io/pypi/v/skops :target: https://pypi.org/project/skops :alt: PyPi

.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black :alt: Black

.. image:: https://raw.githubusercontent.com/skops-dev/skops/main/docs/images/logo.png :width: 500 :target: https://skops.readthedocs.io/en/latest/

SKOPS

skops 是一个 Python 库，旨在帮助您共享基于 scikit-learn <https://scikit-learn.org/stable/>__ 的模型，并将其部署到生产环境中。 目前，它包含 skops.io，用于安全地持久化 scikit-learn 估计器等对象， 而无需使用 pickle。此外，还包含 skops.card，用于创建模型卡片， 解释模型的功能及其使用方法。

• skops.io：安全地持久化 scikit-learn 估计器等对象，无需使用 pickle。更多信息请参阅 文档 <https://skops.readthedocs.io/en/latest/persistence.html>__。
• skops.card：用于创建模型卡片的工具，解释模型的功能及使用方法。 模型卡片可以作为 Hugging Face Hub 上的 README.md 文件保存， 并预填充元数据，以帮助 Hub 理解该模型。更多信息请参阅 这里 <https://skops.readthedocs.io/en/stable/model_card.html>__。

请参阅我们的 文档 <https://skops.readthedocs.io/en/latest/>_，了解如何 作为用户使用该库，其中包含上述主题的用户指南以及完整的示例， 说明如何使用这些功能。

如果您希望为该库做出贡献，请参阅我们的 贡献指南 <CONTRIBUTING.rst>_。

安装

您可以使用以下命令安装此库：

.. code-block:: bash

python -m pip install skops

错误报告和问题

请将您的所有问题和错误报告以 issue 的形式提交到 此仓库的 issue 追踪器 <https://github.com/skops-dev/skops/issues>_。 在创建新 issue 之前，请先查看是否有类似的已存在 issue。

skops 快速上手指南

skops 是一个专为 Python 开发者设计的工具库，旨在帮助你安全地共享基于 scikit-learn 的模型并将其投入生产环境。它提供了安全的模型持久化方案（替代不安全的 pickle）以及自动生成模型卡片（Model Card）的功能。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 操作系统：Linux、macOS 或 Windows
• Python 版本：建议安装 Python 3.8 或更高版本
• 前置依赖：
  • scikit-learn：核心依赖库
  • numpy、scipy：通常随 scikit-learn 自动安装

安装步骤

你可以使用 pip 直接安装最新版本的 skops。

标准安装

python -m pip install skops

国内加速安装（推荐）

如果你在中国大陆地区，建议使用国内镜像源以加快下载速度：

python -m pip install skops -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

skops 主要包含两个核心功能模块：skops.io（安全持久化）和 skops.card（模型卡片生成）。

1. 安全保存与加载模型 (skops.io)

传统的 pickle 模块存在安全风险，skops.io 提供了一种安全的替代方案来序列化和反序列化 sklearn 模型。

from sklearn.linear_model import LogisticRegression
from sklearn.datasets import make_classification
import skops.io as sio

# 1. 训练一个简单的模型
X, y = make_classification()
clf = LogisticRegression(random_state=0).fit(X, y)

# 2. 安全地保存模型到文件
sio.dump(clf, "model.skops")

# 3. 安全地加载模型
loaded_clf = sio.load("model.skops")

# 4. 验证模型
predictions = loaded_clf.predict(X)
print(f"模型预测成功，前 5 个结果：{predictions[:5]}")

2. 生成模型卡片 (skops.card)

模型卡片用于解释模型的功能、用途及限制，可直接作为 Hugging Face Hub 上的 README.md。

from skops.card import Card
from sklearn.linear_model import LogisticRegression
from sklearn.datasets import load_iris

# 1. 准备模型和数据
iris = load_iris()
model = LogisticRegression().fit(iris.data, iris.target)

# 2. 初始化模型卡片
card = Card(model, model_diagram=True)

# 3. 添加元数据和描述
card.metadata.tags = ["classification", "skops"]
card.add(
    "Model Description", 
    "这是一个基于鸢尾花数据集训练的逻辑回归分类模型。"
)
card.add(
    "Intended Use", 
    "该模型仅用于教育演示目的，不建议直接用于生产环境。"
)

# 4. 保存为 README.md 文件
card.save("README.md")
print("模型卡片已生成：README.md")

更多详细用法和高级配置，请参考 官方文档。