yihuier 0.2.0__tar.gz

yihuier-0.2.0/.github/workflows/deploy-docs.yml

@@ -0,0 +1,58 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+          cache-dependency-path: docs/package-lock.json
+
+      - name: Install dependencies
+        run: |
+          cd docs
+          npm ci
+
+      - name: Build
+        run: |
+          cd docs
+          npm run docs:build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

yihuier-0.2.0/.gitignore

@@ -0,0 +1,43 @@
+.DS_Store
+*.pyc
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.ipynb_checkpoints
+data/*
+
+docs/node_modules

yihuier-0.2.0/.python-version

@@ -0,0 +1 @@
+3.13

yihuier-0.2.0/CHANGELOG.md

@@ -0,0 +1,104 @@
+# 更新日志
+
+本文档记录 Yihuier 的所有重要变更。
+
+格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/)，
+版本号遵循 [语义化版本](https://semver.org/lang/zh-CN/)。
+
+## [0.2.0] - 2026-04-23
+
+### 新增
+- 🤖 **AI 智能建模 Skill**：内置专业的风控建模 Skill，让 AI 助手自动引导完成 10 步建模全流程
+  - 自动触发：当询问信用评分卡建模时自动激活
+  - 质量保证：内置 AUC ≥ 0.65、KS ≥ 0.15、PSI < 0.25 质量标准
+  - 智能诊断：自动检测问题并提供优化建议
+- 📚 **完整的 VitePress 文档网站**
+  - 模块化文档结构（指南、概念、API、示例）
+  - GitHub Pages 自动部署
+  - Mermaid 图表支持
+  - 搜索功能
+- ✅ **完善的测试框架**
+  - 61 个单元测试，核心功能全覆盖
+  - pytest 配置和 CI 集成
+  - 测试覆盖率报告
+- 🔧 **类型提示和代码规范化**
+  - 完整的类型注解（Python 3.13+）
+  - ruff 代码格式化和检查
+  - 统一的代码风格
+
+### 修复
+- 修复文档中的死链问题（18 个）
+- 修复绘图函数返回值类型不一致
+- 修复分箱边界处理逻辑
+- 修复数据预处理模块中的常变量删除逻辑
+- 修复 XGBoost API 变更导致的兼容性问题
+
+### 文档
+- 新增快速开始指南
+- 新增 API 参考文档
+- 新增最佳实践指南
+- 新增高级示例集合
+- 新增 AI Skill 专题文档
+- 新增架构设计文档
+
+### 改进
+- 优化项目结构和模块组织
+- 改进错误处理和异常提示
+- 增强 API 一致性和易用性
+- 提升代码可维护性
+
+### 技术栈
+- Python 3.13+
+- pandas >= 2.1.4
+- scikit-learn >= 1.3.2
+- xgboost >= 2.0.3
+- matplotlib >= 3.8.2
+- seaborn >= 0.12.2
+
+## [0.1.13] - 2024-XX-XX
+
+### 新增
+- 🎉 首次发布 Yihuier 评分卡建模工具包
+- 完整的面向对象建模架构
+- 9 个核心模块：EDA、数据预处理、分箱、变量选择、模型评估、评分卡实现、评分卡监控、聚类、流水线
+- 支持多种分箱方法：ChiMerge、等频、等距、单调性分箱
+- 完整的 WOE 转换和 IV 计算
+- 多种变量选择策略：XGBoost、随机森林、相关性筛选
+- 评分卡刻度计算和分数转换
+- PSI 稳定性分析和模型监控
+- 完整的类型提示（Python 3.13+）
+- 61 个单元测试，核心功能全覆盖
+- AI 智能建模 Skill（Claude Code 支持）
+
+### 文档
+- 完整的 VitePress 文档站点
+- 快速开始指南
+- API 参考文档
+- 最佳实践指南
+- 高级示例集合
+- 模块化文档结构
+
+### 技术栈
+- Python 3.13+
+- pandas >= 2.1.4
+- scikit-learn >= 1.3.2
+- xgboost >= 2.0.3
+- matplotlib >= 3.8.2
+- seaborn >= 0.12.2
+
+## [未发布]
+
+### 计划中
+- 更多分箱方法（决策树分箱、最优分箱）
+- 自动化特征工程模块
+- 模型对比和自动选择
+- 更多评估指标和可视化
+- GPU 加速支持
+- 分布式计算支持
+
+---
+
+## 版本说明
+
+- **[0.1.0]** - 初始发布版本，包含完整的评分卡建模功能
+- **[未发布]** - 计划中的功能和改进

yihuier-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Justin Gao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

yihuier-0.2.0/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: yihuier
+Version: 0.2.0
+Summary: 评分卡模型实现函数模块 - 轻松解决逻辑回归建模
+Project-URL: Homepage, https://github.com/ency/yihuier
+Project-URL: Repository, https://github.com/ency/yihuier
+Project-URL: Documentation, https://ency.github.io/yihuier/
+Project-URL: Issues, https://github.com/ency/yihuier/issues
+Author: Justin Gao
+License: MIT
+License-File: LICENSE
+Keywords: credit-scoring,logistic-regression,machine-learning,scorecard
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.13
+Requires-Dist: matplotlib>=3.8.2
+Requires-Dist: numpy>=1.26.0
+Requires-Dist: pandas>=2.1.4
+Requires-Dist: scikit-learn>=1.3.2
+Requires-Dist: scipy>=1.11.0
+Requires-Dist: seaborn>=0.12.2
+Requires-Dist: statsmodels>=0.14.0
+Requires-Dist: tqdm>=4.66.1
+Requires-Dist: xgboost>=2.0.3
+Provides-Extra: all
+Requires-Dist: pytest-cov>=4.0.0; extra == 'all'
+Requires-Dist: pytest>=7.0.0; extra == 'all'
+Requires-Dist: ruff>=0.1.0; extra == 'all'
+Requires-Dist: ydata-profiling>=4.6.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Provides-Extra: profiling
+Requires-Dist: ydata-profiling>=4.6.0; extra == 'profiling'
+Description-Content-Type: text/markdown
+
+# Yihuier
+
+一会儿轻松解决信用评分卡建模
+
+基于 [Scorecard--Function](https://github.com/taenggu0309/Scorecard--Function) 重构的面向对象版本。
+
+## 特性
+
+- **面向对象设计** - 统一的 Yihuier 类管理数据和状态
+- **完整建模流程** - EDA → 数据处理 → 分箱 → 变量选择 → 模型评估 → 评分卡实现 → 监控
+- **模块化架构** - 9个独立模块，职责清晰
+- **类型提示** - 完整的类型注解，更好的IDE支持
+
+## 快速开始
+
+### 安装
+
+```bash
+# 使用 pip
+pip install yihuier
+
+# 或使用 uv
+uv pip install yihuier
+```
+
+### 基础使用
+
+```python
+import pandas as pd
+from yihuier import Yihuier
+
+# 加载数据
+data = pd.read_csv('data.csv')
+yh = Yihuier(data, target='dlq_flag')
+
+# 数据预处理
+data_clean = yh.dp_module.delete_missing_var(threshold=0.15)
+
+# 变量分箱
+bin_df, iv_value = yh.binning_module.binning_num(
+    col_list=['v1', 'v2', 'v3'],
+    max_bin=5,
+    method='ChiMerge'
+)
+
+# WOE转换
+woe_df = yh.binning_module.woe_df_concat()
+data_woe = yh.binning_module.woe_transform()
+
+# 变量选择
+xg_imp, xg_rank, xg_cols = yh.var_select_module.select_xgboost(
+    col_list=data_woe.drop(['dlq_flag'], axis=1).columns.tolist(),
+    imp_num=10
+)
+
+# 模型训练
+from sklearn.linear_model import LogisticRegression
+model = LogisticRegression()
+model.fit(data_woe[xg_cols], data_woe['dlq_flag'])
+
+# 模型评估
+y_pred = model.predict_proba(x_test)[:, 1]
+yh.me_module.plot_roc(y_test, y_pred)
+yh.me_module.plot_model_ks(y_test, y_pred)
+```
+
+## 模块概览
+
+| 模块 | 功能 | 文档 |
+|------|------|------|
+| `EDAModule` | 探索性数据分析 | [📖 EDA 模块](https://encyc.github.io/yihuier/guide/modules/eda.html) |
+| `DataProcessingModule` | 数据预处理 | [📖 数据预处理](https://encyc.github.io/yihuier/guide/modules/data-processing.html) |
+| `BinningModule` | 变量分箱 | [📖 分箱模块](https://encyc.github.io/yihuier/guide/modules/binning.html) |
+| `VarSelectModule` | 变量选择 | [📖 变量选择](https://encyc.github.io/yihuier/guide/modules/var-select.html) |
+| `ModelEvaluationModule` | 模型评估 | [📖 模型评估](https://encyc.github.io/yihuier/guide/modules/model-evaluation.html) |
+| `ScorecardImplementModule` | 评分卡实现 | [📖 评分卡实现](https://encyc.github.io/yihuier/guide/modules/scorecard-implement.html) |
+| `ScorecardMonitorModule` | 评分卡监控 | [📖 评分卡监控](https://encyc.github.io/yihuier/guide/modules/scorecard-monitor.html) |
+| `ClusterModule` | 聚类分析 | [📖 聚类模块](https://encyc.github.io/yihuier/guide/modules/cluster.html) |
+| `PipelineModule` | 流水线 | [📖 流水线模块](https://encyc.github.io/yihuier/guide/modules/pipeline.html) |
+
+## 📚 完整文档
+
+- **[在线文档](https://encyc.github.io/yihuier/)** - VitePress 部署的完整文档网站
+- **[快速开始](https://encyc.github.io/yihuier/guide/quick-start)** - 5分钟快速上手
+- **[API 参考](https://encyc.github.io/yihuier/guide/api)** - 完整的 API 文档
+- **[最佳实践](https://encyc.github.io/yihuier/guide/best-practices)** - 行业最佳实践指南
+- **[示例集合](https://encyc.github.io/yihuier/guide/examples)** - 常用场景代码示例
+
+## 开发
+
+```bash
+# 克隆项目
+git clone https://github.com/ency/yihuier.git
+cd yihuier
+
+# 安装开发依赖
+uv pip install -e ".[dev]"
+
+# 运行测试
+pytest tests/ -v
+
+# 代码格式化
+ruff format yihuier/
+ruff check yihuier/
+```
+
+## 许可证
+
+MIT License
+
+## 致谢
+
+- 原项目: [Scorecard--Function](https://github.com/taenggu0309/Scorecard--Function)
+- 相关文章: [知乎专栏](https://zhuanlan.zhihu.com/p/675830391)

yihuier-0.2.0/PYPI_PUBLISHING.md

@@ -0,0 +1,138 @@
+# PyPI 发布指南
+
+## 发布前检查清单
+
+### ✅ 已完成
+
+- [x] pyproject.toml 配置完整
+- [x] README.md 内容完善
+- [x] LICENSE 文件创建（MIT）
+- [x] 版本号定义（0.1.0）
+- [x] 依赖声明完整
+- [x] 构建工具安装（build, twine）
+- [x] 包构建测试通过
+- [x] twine check 验证通过
+
+### 📦 构建产物
+
+```bash
+dist/
+├── yihuier-0.1.0-py3-none-any.whl  (42KB)
+└── yihuier-0.1.0.tar.gz            (1.5MB)
+```
+
+## 发布步骤
+
+### 1. 配置 PyPI API Token
+
+```bash
+# 创建 ~/.pypirc
+cat > ~/.pypirc << 'EOF'
+[distutils]
+index-servers =
+    pypi
+    testpypi
+
+[pypi]
+username = __token__
+password = <your-pypi-token>
+
+[testpypi]
+username = __token__
+password = <your-testpypi-token>
+EOF
+```
+
+**获取 Token**：
+- 访问 https://pypi.org/manage/account/token/
+- 创建新的 API token
+- 将 token 粘贴到 ~/.pypirc 中
+
+### 2. 测试发布（推荐）
+
+先发布到 TestPyPI 验证：
+
+```bash
+# 发布到 TestPyPI
+python -m twine upload --repository testpypi dist/*
+
+# 测试安装
+pip install --index-url https://test.pypi.org/simple/ yihuier
+```
+
+### 3. 正式发布
+
+```bash
+# 发布到 PyPI
+python -m twine upload dist/*
+```
+
+### 4. 验证发布
+
+```bash
+# 等待 1-2 分钟后
+pip install yihuier
+
+# 验证安装
+python -c "from yihuier import Yihuier; print(Yihuier.__doc__)"
+```
+
+## 发布后注意事项
+
+1. **版本管理**：下次发布前更新版本号
+   ```toml
+   # pyproject.toml
+   version = "0.1.1"  # 或 0.2.0, 1.0.0 等
+   ```
+
+2. **Git 标签**：为每个发布版本打标签
+   ```bash
+   git tag v0.1.0
+   git push origin v0.1.0
+   ```
+
+3. **GitHub Release**：在 GitHub 创建 Release
+   - 上传构建的 dist 文件
+   - 添加更新日志
+
+4. **文档更新**：确保文档站点版本号一致
+
+## 常见问题
+
+### Q: 包名已被占用怎么办？
+
+A: 在 pyproject.toml 中修改包名：
+```toml
+name = "yihuier-scorecard"  # 或其他可用名称
+```
+
+### Q: 上传失败怎么办？
+
+A: 检查：
+1. Token 是否正确
+2. 版本号是否已存在（不能重复上传相同版本）
+3. 网络连接是否正常
+
+### Q: 如何撤销已发布的包？
+
+A: PyPI 不支持删除包，但可以：
+1. 发布新版本修复问题
+2. 联系 PyPI 管理员（紧急情况）
+
+## 版本号规范
+
+遵循语义化版本（Semantic Versioning）：
+
+- **MAJOR.MINOR.PATCH**（如 1.2.3）
+- **MAJOR**：不兼容的 API 变更
+- **MINOR**：向后兼容的功能新增
+- **PATCH**：向后兼容的问题修复
+
+首次发布建议：**0.1.0** 或 **1.0.0**
+
+## 后续改进
+
+- [ ] 添加 GitHub Actions 自动发布
+- [ ] 配置 CI/CD 自动测试
+- [ ] 添加更多示例代码
+- [ ] 完善文档和教程

yihuier-0.2.0/README.md

@@ -0,0 +1,114 @@
+# Yihuier
+
+一会儿轻松解决信用评分卡建模
+
+基于 [Scorecard--Function](https://github.com/taenggu0309/Scorecard--Function) 重构的面向对象版本。
+
+## 特性
+
+- **面向对象设计** - 统一的 Yihuier 类管理数据和状态
+- **完整建模流程** - EDA → 数据处理 → 分箱 → 变量选择 → 模型评估 → 评分卡实现 → 监控
+- **模块化架构** - 9个独立模块，职责清晰
+- **类型提示** - 完整的类型注解，更好的IDE支持
+
+## 快速开始
+
+### 安装
+
+```bash
+# 使用 pip
+pip install yihuier
+
+# 或使用 uv
+uv pip install yihuier
+```
+
+### 基础使用
+
+```python
+import pandas as pd
+from yihuier import Yihuier
+
+# 加载数据
+data = pd.read_csv('data.csv')
+yh = Yihuier(data, target='dlq_flag')
+
+# 数据预处理
+data_clean = yh.dp_module.delete_missing_var(threshold=0.15)
+
+# 变量分箱
+bin_df, iv_value = yh.binning_module.binning_num(
+    col_list=['v1', 'v2', 'v3'],
+    max_bin=5,
+    method='ChiMerge'
+)
+
+# WOE转换
+woe_df = yh.binning_module.woe_df_concat()
+data_woe = yh.binning_module.woe_transform()
+
+# 变量选择
+xg_imp, xg_rank, xg_cols = yh.var_select_module.select_xgboost(
+    col_list=data_woe.drop(['dlq_flag'], axis=1).columns.tolist(),
+    imp_num=10
+)
+
+# 模型训练
+from sklearn.linear_model import LogisticRegression
+model = LogisticRegression()
+model.fit(data_woe[xg_cols], data_woe['dlq_flag'])
+
+# 模型评估
+y_pred = model.predict_proba(x_test)[:, 1]
+yh.me_module.plot_roc(y_test, y_pred)
+yh.me_module.plot_model_ks(y_test, y_pred)
+```
+
+## 模块概览
+
+| 模块 | 功能 | 文档 |
+|------|------|------|
+| `EDAModule` | 探索性数据分析 | [📖 EDA 模块](https://encyc.github.io/yihuier/guide/modules/eda.html) |
+| `DataProcessingModule` | 数据预处理 | [📖 数据预处理](https://encyc.github.io/yihuier/guide/modules/data-processing.html) |
+| `BinningModule` | 变量分箱 | [📖 分箱模块](https://encyc.github.io/yihuier/guide/modules/binning.html) |
+| `VarSelectModule` | 变量选择 | [📖 变量选择](https://encyc.github.io/yihuier/guide/modules/var-select.html) |
+| `ModelEvaluationModule` | 模型评估 | [📖 模型评估](https://encyc.github.io/yihuier/guide/modules/model-evaluation.html) |
+| `ScorecardImplementModule` | 评分卡实现 | [📖 评分卡实现](https://encyc.github.io/yihuier/guide/modules/scorecard-implement.html) |
+| `ScorecardMonitorModule` | 评分卡监控 | [📖 评分卡监控](https://encyc.github.io/yihuier/guide/modules/scorecard-monitor.html) |
+| `ClusterModule` | 聚类分析 | [📖 聚类模块](https://encyc.github.io/yihuier/guide/modules/cluster.html) |
+| `PipelineModule` | 流水线 | [📖 流水线模块](https://encyc.github.io/yihuier/guide/modules/pipeline.html) |
+
+## 📚 完整文档
+
+- **[在线文档](https://encyc.github.io/yihuier/)** - VitePress 部署的完整文档网站
+- **[快速开始](https://encyc.github.io/yihuier/guide/quick-start)** - 5分钟快速上手
+- **[API 参考](https://encyc.github.io/yihuier/guide/api)** - 完整的 API 文档
+- **[最佳实践](https://encyc.github.io/yihuier/guide/best-practices)** - 行业最佳实践指南
+- **[示例集合](https://encyc.github.io/yihuier/guide/examples)** - 常用场景代码示例
+
+## 开发
+
+```bash
+# 克隆项目
+git clone https://github.com/ency/yihuier.git
+cd yihuier
+
+# 安装开发依赖
+uv pip install -e ".[dev]"
+
+# 运行测试
+pytest tests/ -v
+
+# 代码格式化
+ruff format yihuier/
+ruff check yihuier/
+```
+
+## 许可证
+
+MIT License
+
+## 致谢
+
+- 原项目: [Scorecard--Function](https://github.com/taenggu0309/Scorecard--Function)
+- 相关文章: [知乎专栏](https://zhuanlan.zhihu.com/p/675830391)