https://github.com/explosion/weasel
🦦 weasel: A small and easy workflow system
https://github.com/explosion/weasel
python
Last synced: 9 months ago
JSON representation
🦦 weasel: A small and easy workflow system
- Host: GitHub
- URL: https://github.com/explosion/weasel
- Owner: explosion
- License: mit
- Created: 2022-09-27T10:13:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-28T18:25:52.000Z (over 1 year ago)
- Last Synced: 2025-03-29T11:04:27.969Z (10 months ago)
- Topics: python
- Language: Python
- Homepage:
- Size: 1.8 MB
- Stars: 80
- Watchers: 3
- Forks: 8
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Weasel: A small and easy workflow system
Weasel lets you manage and share **end-to-end workflows** for
different **use cases and domains**, and orchestrate training, packaging and
serving your custom pipelines. You can start off by cloning a pre-defined
project template, adjust it to fit your needs, load in your data, train a
pipeline, export it as a Python package, upload your outputs to a remote storage
and share your results with your team. Weasel can be used via the
[`weasel`](https://github.com/explosion/weasel/blob/main/docs/cli.md) command and we provide templates in our
[`projects`](https://github.com/explosion/projects) repo.
## 💡 Example: Get started with a project template
The easiest way to get started is to clone a project template and run it – for
example, this [end-to-end template](https://github.com/explosion/projects/tree/v3/pipelines/tagger_parser_ud)
that lets you train a spaCy **part-of-speech
tagger** and **dependency parser** on a Universal Dependencies treebank.
```shell
python -m weasel clone pipelines/tagger_parser_ud
```
> **Note**
>
> Our [`projects`](https://github.com/explosion/projects) repo includes various
> project templates for different NLP tasks, models, workflows and integrations
> that you can clone and run. The easiest way to get started is to pick a
> template, clone it and start modifying it!
## 📕 Documentation
Get started with the documentation:
- [Learn how to create a Weasel workflow](https://github.com/explosion/weasel/blob/main/docs/tutorial/workflow.md)
- [Working with directory and assets](https://github.com/explosion/weasel/blob/main/docs/tutorial/directory-and-assets.md)
- [Running custom scripts](https://github.com/explosion/weasel/blob/main/docs/tutorial/custom-scripts.md)
- [Using remote storage](https://github.com/explosion/weasel/blob/main/docs/tutorial/remote-storage.md)
- [Weasel integrations](https://github.com/explosion/weasel/blob/main/docs/tutorial/integrations.md)
- [Command line interface description](https://github.com/explosion/weasel/blob/main/docs/cli.md)
## Migrating from spaCy Projects
Weasel is a standalone replacement for spaCy Projects.
There are a few backward incompatibilities that you should be aware of:
- The `SPACY_CONFIG_OVERRIDES` environment variable is no longer checked.
You can set configuration overrides using `WEASEL_CONFIG_OVERRIDES`.
- Support for the `spacy_version` configuration key has been dropped.
- Support for the `check_requirements` configuration key has been dropped.
- Support for `SPACY_PROJECT_USE_GIT_VERSION` environment variable has been dropped.
- Error codes are now Weasel-specific, and do not follow spaCy error codes.
Weasel checks for the first three incompatibilities and will issue a
warning if you're using it with spaCy-specific configuration options.