安装

Linux 和 Mac 用户

PyKEEN的最新稳定版本可以从 PyPI 下载并安装:

$ pip install pykeen

最新版本的PyKEEN可以直接从GitHub上的源代码安装,使用以下命令:

$ pip install git+https://github.com/pykeen/pykeen.git

Google Colab 和 Kaggle 用户

Google ColabKaggle 都提供了Google定制的Jupyter笔记本环境的托管版本,它们的工作方式相似。在这些服务中的一个打开新笔记本后,用以下两行代码开始你的笔记本:

! pip install git+https://github.com/pykeen/pykeen.git
pykeen.env()

这将安装最新的代码,然后使用pykeen.env()输出相关的系统和环境信息。 它之所以有效,是因为Jupyter将任何以感叹号!开头的行解释为bash命令。如果您希望您的笔记本在托管和本地安装上都兼容,可以稍微修改一下以检查是否已经安装了PyKEEN:

! python -c "import pykeen" || pip install git+https://github.com/pykeen/pykeen.git
pykeen.env()

注意

旧版本的PyKEEN使用了class_resolve版本0.3.4及以下,通过入口点加载数据集。这在Kaggle和Google Colab上是不可预测的,因此在https://github.com/pykeen/pykeen/pull/832中移除了。更多信息也可以在PyKEEN问题#373上找到。

要启用GPU使用,请转到运行时 -> 更改运行时类型菜单,以在您的笔记本中启用GPU。

Windows 用户

!95起,我们已经添加了对Windows的实验性支持。 然而,请注意,在Windows上安装PyTorch以及因此安装PyKEEN要复杂得多。

首先,要安装PyTorch,您必须安装Anaconda并按照PyTorch网站上的说明进行操作。 然后,假设您的pythonpip命令链接到conda安装的同一位置,您可以继续进行正常安装(或如上所示的从GitHub安装):

$ pip install pykeen

如果你在使用pipsqlite时遇到问题,你可能还需要使用 conda install pip setuptools wheel sqlite。请参阅我们的 GitHub Actions配置 在GitHub上获取灵感。

如果您知道更好的在Windows上安装的方法或想分享一些参考资料,我们将非常感激。

开发

最新的代码可以通过以下方式以开发模式安装:

$ git clone https://github.com/pykeen/pykeeen.git pykeen
$ cd pykeen
$ pip install -e .

如果您有兴趣做出贡献,请参阅我们的 贡献指南

为了自动确保遵守我们的风格指南,请在同一目录下使用以下代码块安装预提交钩子。

$ pip install pre-commit
$ pre-commit install

附加内容

PyKEEN 有几个额外的安装选项,这些选项定义在 [options.extras_require] 部分的 setup.cfg 中。它们可以通过使用括号符号在安装时包含,例如 pip install pykeen[docs]pip install -e .[docs]。可以列出多个选项,用逗号分隔,例如 pip install pykeen[docs,plotting]

名称

描述

templating

构建模板化文档,如README

plotting

使用seaborn进行绘图和生成词云

mlflow

使用mlflow跟踪结果

wandb

使用wandb跟踪结果

neptune

使用neptune跟踪结果

tensorboard

通过torch.utils.tensorboard使用tensorboard跟踪结果

transformers

使用transformers进行基于标签的初始化。

tests

运行测试所需的代码。通常使用tox -e py处理。

docs

文档的构建

opt_einsum

通过替换为opt_einsum.contract()来提高torch.einsum()的性能

生物医学

使用 pyobo 查找生物医学实体标签