Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/explosion/vscode-prodigy
🧬 A VS Code extension for annotating data with Prodigy
https://github.com/explosion/vscode-prodigy
annotation-tool data-annotation data-labeling data-labeling-tools data-science labeling-tool nlp prodigy spacy vscode vscode-extension
Last synced: 3 months ago
JSON representation
🧬 A VS Code extension for annotating data with Prodigy
- Host: GitHub
- URL: https://github.com/explosion/vscode-prodigy
- Owner: explosion
- License: mit
- Created: 2021-11-22T02:16:39.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2021-11-25T10:18:28.000Z (about 3 years ago)
- Last Synced: 2024-09-30T05:40:51.580Z (3 months ago)
- Topics: annotation-tool, data-annotation, data-labeling, data-labeling-tools, data-science, labeling-tool, nlp, prodigy, spacy, vscode, vscode-extension
- Language: TypeScript
- Homepage:
- Size: 25.9 MB
- Stars: 30
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# VS Code extension for the Prodigy annotation tool ✨
[](https://github.com/explosion/vscode-prodigy/actions/workflows/ci.yml)
This repo contains a [VS Code](https://code.visualstudio.com/) extension for
[Prodigy](https://prodi.gy), our scriptable annotation tool for creating
training data for machine learning models. It lets you run Prodigy within a VS
Code Panel, and annotate as you develop your models and applications.
In order to use this extension, you'll need a license for Prodigy—[see
this page](https://prodi.gy/buy) for more details. For issues and questions,
please use the [Prodigy Support Forum](https://support.prodi.gy/). If you've
found a bug, feel free to submit a [pull
request](https://github.com/explosion/vscode-prodigy/pulls)
## ⌛️ Installation
Get from the [VS Code marketplace](https://marketplace.visualstudio.com/items?itemName=Explosion.vscode-prodigy)
## 📋 Usage
Start a Prodigy session in a terminal, e.g.:
```bash
prodigy ner.manual my_set blank:en example/news_headlines.jsonl --label PERSON,ORG,PRODUCT
```
In VS Code, open the Command Palette (Ctrl + Shift + P)
and select `Open Prodigy`. Execute it, and you will have a new Prodigy panel on the side.
## ⚙ Configuration
This extension contributes the following settings:
| Configuration | Description |
|--------------------|--------------------------------------------------------------------------------------|
| vscode-prodigy.url | Set the URL where Prodigy is being served at. Useful when you're in a reverse proxy. |
## 👩💻 Develop
You need [Visual Studio Code](https://code.visualstudio.com/) and
[Typescript](https://www.typescriptlang.org/) for development. First, clone this
repository:
```bash
git clone [email protected]:explosion/vscode-prodigy.git
```
and open the `vscode-prodigy` folder in Code:
```bash
cd vscode-prodigy
code .
```
### Get up and running straight away
* Press F5 to open a new window with your extension loaded.
* Run your command from the command palette by pressing (Ctrl+Shift+P or Cmd+Shift+P on Mac) and typing `Open Prodigy`.
* Set breakpoints in your code inside `src/extension.ts` to debug your extension.
* Find output from your extension in the debug console.
### Make changes
* You can relaunch the extension from the debug toolbar after changing code in `src/extension.ts`.
* You can also reload (Ctrl+R or Cmd+R on Mac) the VS Code window with your extension to load your changes.
### Run tests
* Open the debug viewlet (Ctrl+Shift+D or Cmd+Shift+D on Mac) and from the launch configuration dropdown pick `Extension Tests`.
* Press F5 to run the tests in a new window with your extension loaded.
* See the output of the test result in the debug console.
* Make changes to `src/test/suite/extension.test.ts` or create new test files inside the `test/suite` folder.
* The provided test runner will only consider files matching the name pattern `**.test.ts`.