JupyterLab Prodigy扩展安装与使用指南

JupyterLab Prodigy扩展安装与使用指南

jupyterlab-prodigy🧬 A JupyterLab extension for annotating data with Prodigy项目地址:https://gitcode.com/gh_mirrors/ju/jupyterlab-prodigy

1. 项目目录结构及介绍

JupyterLab Prodigy扩展位于explosion/jupyterlab-prodigy仓库中。以下是典型的基础目录结构概述，它可能随着版本更新而有所变化：

.
├── LICENSE
├── README.md          # 项目说明文件，包含了快速入门指导。
├── pyproject.toml     # Python项目配置文件，定义依赖项等。
├── setup.cfg          # 配置编译和打包选项。
├── src                # 源代码目录
│   └── jupyterlab_prodigy  # 扩展的核心代码
│       ├── __init__.py
│       └── ...             # 其他Python源代码文件
├── tests              # 测试目录，包含单元测试和集成测试。
└── setup.py           # Python经典的setup脚本，用于安装包。

• LICENSE: 许可证文件，描述了如何合法地使用此软件。
• README.md: 主要的文档，包括安装步骤、快速开始和其他重要信息。
• pyproject.toml: 使用PEP 517/518定义构建系统的配置文件。
• setup.*: 包含了Python包的元数据和安装指令。
• src/jupyterlab_prodigy: 存放着扩展的具体实现代码。
• tests: 确保扩展功能正常的测试案例集合。

2. 项目的启动文件介绍

在使用JupyterLab Prodigy之前，关键的“启动过程”不是直接通过一个特定的“启动文件”，而是通过命令行来执行的，主要涉及以下步骤：

1. 安装JupyterLab: 首先确保你的环境中装有JupyterLab且版本需满足≥3.0.0。

2. 安装JupyterLab Prodigy扩展:

   pip install jupyterlab-prodigy
   

   这条命令将会下载并安装必要的组件，使你能够在JupyterLab中使用Prodigy。

3. 启用扩展: 安装后通常自动启用，若未自动启用，可以通过下面的命令手动启用或检查状态：

   jupyter labextension enable jupyterlab-prodigy
   

4. 启动JupyterLab:

   jupyter lab
   

   之后，在浏览器中打开的JupyterLab界面里，你应该能看到Prodigy的注解界面作为其中一个标签页出现（需要注意的是，根据用户的报告，某些情况下这可能需要手动访问服务器URL）。

3. 项目的配置文件介绍

Prodigy本身提供了丰富的配置选项，但这些通常在.prodigy.json或通过环境变量进行设置，而不是直接与JupyterLab Prodigy扩展的安装有关。对于JupyterLab Prodigy的特定配置，大多数设置是通过Prodigy的任务命令(prodigy <task>)时指定，或是在创建新的Prodigy应用时进行配置。

然而，在JupyterLab端，配置更多涉及到环境变量或者JupyterLab本身的设置。例如，如果你需要调整JupyterLab的启动参数或特定于 Prodigy 的行为，可以通过修改Jupyter的配置文件（如.jupyter/jupyter_notebook_config.py）或使用环境变量来实现。

总结而言，虽然直接的配置文件并非显式存在于扩展的表面层次，但结合Prodigy任务和JupyterLab的个性化需求，通过适当的命令行参数或环境配置，可以达到定制化目的。务必参考Prodigy的官方文档以获取更详细的配置信息。

jupyterlab-prodigy🧬 A JupyterLab extension for annotating data with Prodigy项目地址:https://gitcode.com/gh_mirrors/ju/jupyterlab-prodigy