TabNine for Jupyter Notebook

此插件由 wenmin-wu 创建。

此插件已在 macOS、Linux 和 Windows 上测试通过，支持所有这些操作系统。浏览器方面支持 Chrome 和 Safari，但不支持 IE。

如果您发现此插件无法正常工作，请按照 如何调试 进行排查。如果仍无法解决问题，请提交 issue 并详细描述日志信息。

感谢您使用此插件！祝您使用愉快！ :)

以其他语言阅读：英语, 中文

此 Jupyter Notebook 扩展允许在基于深度学习的代码自动补全功能中使用 TabNine。

TabNine 的其他客户端插件需要启动一个 TabNine 二进制文件的子进程，并通过管道进行通信。然而，在 Jupyter Notebook 中无法实现这一点，因为无法使用 jQuery 创建子进程，且 Jupyter Notebook 也不提供向插件添加第三方 JavaScript 库的方法。

为此，本仓库开发了一个适用于 Jupyter Notebook 的客户端插件和服务器插件。客户端插件会生成请求信息并发送 HTTP 请求至服务器插件，而服务器插件则将请求传递给其内部的 TabNine 客户端进程，并将结果返回给客户端插件。

安装

我发现许多用户遇到问题是因为没有正确安装和配置此插件。最简单的安装和配置方法是执行以下命令：

pip3 install jupyter-tabnine --user
jupyter nbextension install --py jupyter_tabnine --user
jupyter nbextension enable --py jupyter_tabnine --user
jupyter serverextension enable --py jupyter_tabnine --user

如果您希望以自定义方式安装和配置，可以参考以下步骤：

该扩展包含一个 PyPI 包，其中包含了 JavaScript Notebook 扩展以及 Python Jupyter 服务器扩展。自 Jupyter 4.2 起，推荐使用 PyPI 来分发 Notebook 扩展。您可以从以下途径安装此扩展：

• 直接从 GitHub 仓库的主分支（始终是最新的版本）
• 或通过 PyPI 上托管的版本

无论是从 GitHub 仓库还是 PyPI 安装：

1. 安装包
   • pip3 install https://github.com/wenmin-wu/jupyter-tabnine/archive/master.zip [--user][--upgrade]
   • 或者 pip3 install jupyter-tabnine [--user][--upgrade]
   • 或者克隆仓库后手动安装： git clone https://github.com/wenmin-wu/jupyter-tabnine.git python3 setup.py install
2. 安装 Notebook 扩展 jupyter nbextension install --py jupyter_tabnine [--user|--sys-prefix|--system]
3. 启用 Notebook 扩展和服务器扩展

   jupyter nbextension enable --py jupyter_tabnine [--user|--sys-prefix|--system]
   jupyter serverextension enable --py jupyter_tabnine [--user|--sys-prefix|--system]
   

---

对于 Jupyter 4.2 之前的版本，在完成第 1 步之后的情况会稍微复杂一些，因为没有 --py 选项可用，因此您需要手动找到源文件的位置，具体操作如下（参考 @jcb91 的 jupyter_highlight_selected_word 指南）：执行以下命令：

python -c "import os.path as p; from jupyter_tabnine import __file__ as f, _jupyter_nbextension_paths as n; print(p.normpath(p.join(p.dirname(f), n()[0]['src'])))"

然后执行：

jupyter nbextension install <输出源目录>
jupyter nbextension enable jupyter_tabnine/main
jupyter serverextension enable < 输出源目录 >

其中 < 输出源目录 > 是上述 Python 命令的输出结果。

使用

• Jupyter TabNine 在安装完成后即可生效。有时您可能需要暂时显示 Jupyter 自带的原始补全提示，此时只需按下 Shift + Space 键。
• 此外，还支持远程自动补全服务器。这有助于加快补全请求的处理速度，或者当您的公司希望部署一个为所有人服务的补全服务器集群时，也可以采用这种方式。有关如何部署远程服务器的详细信息，请参阅下文。

卸载

要在 Mac/Linux 上卸载 TabNine 插件，请运行以下命令：

jupyter nbextension uninstall --py jupyter_tabnine
pip3 uninstall jupyter-tabnine

贡献

欢迎提交 Pull Request。对于重大更改，请先打开 Issue 讨论您计划修改的内容。

请确保相应地更新测试用例。

许可证

MIT 许可证

部署远程补全服务器

如果您不想占用过多本地资源，部署一个远程 TabNine 服务器会非常有用。您可以按照以下步骤构建、部署和配置远程 TabNine 服务器。

注意： 您需要使用 pip3 install https://github.com/wenmin-wu/jupyter-tabnine/archive/master.zip 来安装 jupyter-tabnine，因为修复了与远程服务器相关问题的版本尚未发布到 PyPI。

构建服务器镜像

我已经将镜像上传到了 Docker Hub，如果您想直接使用，可以跳过本节。

• 安装 Go 语言（推荐版本为 1.13 - 1.14）
• 执行 go get -v github.com/wenmin-wu/jupyter-tabnine/go/cmd
• 切换到 $HOME/go/src/github.com/wenmin-wu/jupyter-tabnine
• 执行 bash ./build-image.sh

启动服务器

如果您没有自行构建镜像，请将此脚本中的镜像名称改为 wuwenmin1991/tabnine-server:1.0

• 直接执行 bash start-server.sh

在 Notebook 扩展中配置

• 如果您尚未安装 Notebook 扩展，请先 安装 Notebook 扩展。
• 打开 Jupyter Notebook，进入 Notebook 扩展设置页面，点击 Jupyter TabNine，向下滚动并填写远程服务器的 URL，例如：

停止服务器

• 直接执行 bash stop-server.sh

星标数量随时间变化

jupyter-tabnine 快速上手指南

jupyter-tabnine 是一款为 Jupyter Notebook 设计的智能代码补全插件，基于深度学习技术提供类似 IDE 的自动补全体验。

环境准备

• 操作系统：支持 macOS、Linux 和 Windows。
• 浏览器：推荐使用 Chrome 或 Safari（不支持 IE）。
• 前置依赖：
  • Python 3 及 pip3
  • Jupyter Notebook (建议版本 >= 4.2)
• 网络提示：由于 TabNine 二进制文件需要从云端下载，国内用户若遇到安装卡顿，请确保网络通畅或配置合适的代理。

安装步骤

最简便的安装方式是通过 pip 一键完成安装与配置。请在终端执行以下命令：

pip3 install jupyter-tabnine --user
jupyter nbextension install --py jupyter_tabnine --user
jupyter nbextension enable --py jupyter_tabnine --user
jupyter serverextension enable --py jupyter_tabnine --user

注意：安装完成后，请重启 Jupyter Notebook 服务以使插件生效。

基本使用

1. 启动插件：安装并重启后，插件会自动激活。在代码单元格中输入代码时，TabNine 会根据上下文自动弹出补全建议。
2. 切换模式：
   • 默认使用 TabNine 智能补全。
   • 若需临时切换回 Jupyter 原生补全功能，按下 Shift + Space 即可。
3. 高级配置（可选）：
   • 若希望将计算任务卸载到远程服务器以节省本地资源，可部署远程 TabNine 服务。
   • 部署后，需在 Jupyter 的 Nbextensions 设置页面中找到 Jupyter TabNine 选项，填入远程服务器地址（URL）进行配置。