使用 Python 函数的轻量级流水线
项目描述
带有用户文档的 joblib 主页位于:
获取最新代码
要使用 git 获取最新代码,只需键入:
git clone git://github.com/joblib/joblib.git
如果您没有安装 git,您可以下载最新代码的 zip 或 tarball:http: //github.com/joblib/joblib/archives/master
安装
您可以使用pip安装 joblib:
pip install joblib
从任何目录或:
python setup.py install
从源目录。
依赖项
Joblib 除了 Python 之外没有强制依赖项(支持的版本是 3.7+)。
Joblib 对 Numpy(至少版本 1.6.1)有一个可选的依赖项来进行数组操作。
Joblib 包含自己的 loky 供应商副本, 用于流程管理。
Joblib 可以有效地转储和加载 numpy 数组,但不需要安装 numpy。
Joblib 对python- lz4 有一个可选的依赖, 作为 zlib 和 gzip 压缩序列化的更快替代品。
Joblib 对 psutil 有一个可选的依赖项,以减轻并行工作进程中的内存泄漏。
一些示例需要外部依赖项,例如 pandas。有关详细信息,请参阅构建文档部分中的说明。
贡献的工作流程
要为 joblib 做出贡献,首先在github上创建一个帐户。完成此操作后,将joblib 存储库创建为您自己的存储库,在您要工作的计算机上使用“git clone”克隆它。在您的克隆中进行更改,将它们推送到您的 github 帐户,在多台计算机上测试它们,当您对它们感到满意时,向主存储库发送拉取请求。
运行测试套件
要运行测试套件,您需要 pytest(版本 >= 3)和覆盖模块。使用以下命令运行测试套件:
pytest joblib
从项目的根目录。
构建文档
要构建文档,您需要安装 sphinx (>=1.4) 和一些依赖项:
pip install -U -r .readthedocs-requirements.txt
然后可以使用以下命令构建文档:
make doc
html 文档位于doc/_build/html目录中。
制作源压缩包
要创建源 tarball,例如用于打包或分发,请运行以下命令:
python setup.py sdist
压缩包将在dist目录中创建。此命令将编译文档,并且可以安装生成的 tarball,而不需要比 Python 标准库额外的依赖项。您将需要 setuptool 和 sphinx。
发布并上传到 PyPI
此命令仅由项目经理运行,用于发布并上传到 PyPI:
python setup.py sdist bdist_wheel twine upload dist/*
请注意,文档应在每次 git push 时自动更新。如果不是这种情况,请尝试在本地构建文档并解决任何文档构建错误(特别是在运行示例时)。
更新变更日志
更改列在 CHANGES.rst 文件中。它们必须手动更新,但可以使用以下 git 命令生成这些行:
git log --abbrev-commit --date=short --no-merges --sparse