安装

hscredit 需要 Python 3.9+。基础安装保持轻量，重型依赖（Boosting、深度学习、调参、PMML 与数据库驱动）按需安装。

基础安装

pip install hscredit

基础依赖包含 numpy、pandas、scipy、scikit-learn、statsmodels、matplotlib、 seaborn、openpyxl 等，足以覆盖数据探索、分箱、编码、特征筛选、评分卡建模、指标计算、可视化与 Excel 报告。

可选能力

安装命令	适用场景
`pip install hscredit[boost]`	XGBoost、LightGBM、CatBoost、NGBoost 等 Boosting 模型
`pip install hscredit[net]`	PyTorch 与 TabNet 深度学习模型
`pip install hscredit[tune]`	Optuna 参数调优和调参看板
`pip install hscredit`	已内置 SHAP 模型解释、特征重要性和单样本分析
`pip install hscredit[pmml]`	PMML 导出相关能力
`pip install hscredit[db-mysql]`	MySQL / MariaDB 连接池与流式读写
`pip install hscredit[db-hive]`	HiveServer2 连接池与流式读写
`pip install hscredit[db-impala]`	Impala / Kudu 连接池与流式读写
`pip install hscredit[db-oracle]`	Oracle 原生连接池与流式读写
`pip install hscredit[db-starrocks]`	StarRocks MySQL 协议与 Stream Load
`pip install hscredit[db-clickhouse]`	ClickHouse 原生 DataFrame 流式读写
`pip install hscredit[db-maxcompute]`	MaxCompute DB-API、原生写入与元数据
`pip install hscredit[database-all]`	安装全部数据库适配器
`pip install hscredit[docs]`	构建本文档所需的 Sphinx 工具链
`pip install hscredit[all]`	安装全部可选能力

备注

PMML 导出（hscredit[pmml]）依赖 sklearn2pmml，运行时需要 Java 11+。若本机 Java 版本过低，调用 ScoreCard.export_pmml(...) 会抛出 UnsupportedClassVersionError，这属于运行环境问题而非库本身缺陷。

备注

数据库驱动全部为可选依赖。基础安装仍可安全导入 Database、QueryStream 和适配器注册接口；只有创建对应数据库连接时才检查驱动。完整指南见数据库与 NoSQL 连接池、读写及表结构导出。

开发模式安装

参与开发或本地验证：

git clone https://github.com/hscredit/hscredit.git
cd hscredit
pip install -e ".[dev]"
pytest tests/ -v

安装工具兼容

hscredit 支持 setuptools 77 至当前最新版，标准安装通过 PEP 517 隔离构建完成。setuptools 82 及以上已经移除 pkg_resources，但 hscredit 的源码、构建入口和运行时均不依赖该模块，因此无需额外安装或恢复它。

若安装过程中出现 ModuleNotFoundError: No module named 'pkg_resources'，请根据完整堆栈确认实际失败的第三方源码包，并优先选择支持当前 Python 的 wheel 或新版依赖。不要为此在 hscredit 环境中全局设置 setuptools<82；这会掩盖第三方包的构建兼容问题，也会阻止验证最新版 setuptools。

验证安装

import hscredit

hscredit.info()          # 打印包信息与模块概览
print(hscredit.__version__)

Agent Skills

hscredit 还提供可供 AI Agent 直接调用的分箱分析和完整报告 Skills。Skills 与 Python 包分别安装，支持从仓库复制、由 Agent 从 GitHub 安装，或上传到 OpenAI 项目。

完整安装、调用示例和环境隔离说明见 Agent Skills。

构建文档

pip install hscredit[docs]
cd docs && make html
# 产物位于 docs/_build/html/index.html