JupyterLab扩展，用于Prodigy注解工具 ✨

此仓库包含一个JupyterLab扩展，用于Prodigy，我们的可脚本注解工具，用于创建机器学习模型的训练数据。它允许您在JupyterLab标签中运行Prodigy，并在开发模型和应用时进行注解。要使用此扩展，您需要Prodigy的许可证 - 请参阅此页面以获取更多详情。如有问题，请使用Prodigy支持论坛。如果您发现了一个错误，请随时提交拉取请求。

🙏 特别感谢 Jupyter核心开发者Grant Nestor帮助我们构建此扩展！

⌛️ 安装

要使用此扩展，您需要JupyterLab >= 3.0.0和Prodigy。

pip install jupyterlab>=3.0.0

要安装扩展，请运行

pip install jupyterlab-prodigy

确保已安装并启用了扩展

jupyter labextension list

卸载

要删除扩展，请运行

pip uninstall jupyterlab-prodigy

兼容性

此扩展与Jupyterlab 3.0.0及以上版本兼容。如果您使用的是版本>=2.0.0和<3.0.0的Jupyterlab，则应安装jupyterlab-prodigy的3.0.0版本

jupyter labextension install jupyterlab-prodigy@3.0.0

📋 使用方法

在终端中启动Prodigy会话，例如

$ prodigy ner.manual my_set blank:en notebooks/news_headlines.jsonl --label PERSON,ORG,PRODUCT

在另一个终端会话中启动JupyterLab

$ jupyter lab

然后在JupyterLab中，在左侧侧边栏打开命令，并搜索/输入

打开Prodigy

执行它，您将在侧边出现新的Prodigy面板。

⚙配置

如果您的Prodigy服务在非默认URL（例如，在反向代理后面）上，您可以在设置中配置要使用的URL。

打开设置菜单，转到高级设置编辑器，选择Prodigy Jupyter扩展的设置，在那里您可以添加自定义URL，例如

{
    "prodigyConfig": {
        "url": "https://prodigy.example.com"
    }
}

👩‍💻开发

注意：您需要NodeJS来构建扩展包。开发时，强烈建议您在虚拟环境中工作。

jlpm命令是JupyterLab安装的固定版本的yarn。您可以使用下面的yarn或npm代替jlpm。

# Clone the repo to your local environment
# Change directory to the jupyterlab-prodigy directory
# Install dev requirements
pip install -r requirements-dev.txt
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

您可以在不同的终端同时监视源目录并运行JupyterLab，以监视扩展源的变化并自动重新构建扩展。

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

当监视命令运行时，每次保存的更改都将立即在本地构建并可供您运行的JupyterLab使用。刷新JupyterLab以在浏览器中加载更改（您可能需要等待几秒钟，直到扩展被重新构建）。

默认情况下，jlpm run build命令为此扩展生成源映射，以便更容易使用浏览器开发工具进行调试。要同时为JupyterLab核心扩展生成源映射，可以运行以下命令

jupyter lab build --minimize=False

卸载

pip uninstall jupyterlab-prodigy

打包扩展

参见RELEASE