<a href="https://explosion.ai"><img src="https://explosion.ai/assets/img/logo.svg" width="125" height="125" align="right" /></a>
# 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/explosion/weasel/",
"name": "weasel",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Explosion",
"author_email": "contact@explosion.ai",
"download_url": "https://files.pythonhosted.org/packages/a7/1a/9c522dd61b52939c217925d3e55c95f9348b73a66a956f52608e1e59a2c0/weasel-0.4.1.tar.gz",
"platform": null,
"description": "<a href=\"https://explosion.ai\"><img src=\"https://explosion.ai/assets/img/logo.svg\" width=\"125\" height=\"125\" align=\"right\" /></a>\n\n# Weasel: A small and easy workflow system\n\nWeasel lets you manage and share **end-to-end workflows** for\ndifferent **use cases and domains**, and orchestrate training, packaging and\nserving your custom pipelines. You can start off by cloning a pre-defined\nproject template, adjust it to fit your needs, load in your data, train a\npipeline, export it as a Python package, upload your outputs to a remote storage\nand share your results with your team. Weasel can be used via the\n[`weasel`](https://github.com/explosion/weasel/blob/main/docs/cli.md) command and we provide templates in our\n[`projects`](https://github.com/explosion/projects) repo.\n\n\n\n## \ud83d\udca1 Example: Get started with a project template\n\nThe easiest way to get started is to clone a project template and run it \u2013\u00a0for\nexample, this [end-to-end template](https://github.com/explosion/projects/tree/v3/pipelines/tagger_parser_ud)\nthat lets you train a spaCy **part-of-speech\ntagger** and **dependency parser** on a Universal Dependencies treebank.\n\n```shell\npython -m weasel clone pipelines/tagger_parser_ud\n```\n\n> **Note**\n>\n> Our [`projects`](https://github.com/explosion/projects) repo includes various\n> project templates for different NLP tasks, models, workflows and integrations\n> that you can clone and run. The easiest way to get started is to pick a\n> template, clone it and start modifying it!\n\n## \ud83d\udcd5 Documentation\n\nGet started with the documentation:\n\n- [Learn how to create a Weasel workflow](https://github.com/explosion/weasel/blob/main/docs/tutorial/workflow.md)\n- [Working with directory and assets](https://github.com/explosion/weasel/blob/main/docs/tutorial/directory-and-assets.md)\n- [Running custom scripts](https://github.com/explosion/weasel/blob/main/docs/tutorial/custom-scripts.md)\n- [Using remote storage](https://github.com/explosion/weasel/blob/main/docs/tutorial/remote-storage.md)\n- [Weasel integrations](https://github.com/explosion/weasel/blob/main/docs/tutorial/integrations.md)\n- [Command line interface description](https://github.com/explosion/weasel/blob/main/docs/cli.md)\n\n## Migrating from spaCy Projects\n\nWeasel is a standalone replacement for spaCy Projects.\nThere are a few backward incompatibilities that you should be aware of:\n\n- The `SPACY_CONFIG_OVERRIDES` environment variable is no longer checked.\n You can set configuration overrides using `WEASEL_CONFIG_OVERRIDES`.\n- Support for the `spacy_version` configuration key has been dropped.\n- Support for the `check_requirements` configuration key has been dropped.\n- Support for `SPACY_PROJECT_USE_GIT_VERSION` environment variable has been dropped.\n- Error codes are now Weasel-specific, and do not follow spaCy error codes.\n\nWeasel checks for the first three incompatibilities and will issue a\nwarning if you're using it with spaCy-specific configuration options.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Weasel: A small and easy workflow system",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://github.com/explosion/weasel/",
"Release notes": "https://github.com/explosion/weasel/releases",
"Source": "https://github.com/explosion/weasel/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2a87abd57374044e1f627f0a905ac33c1a7daab35a3a815abfea4e1bafd3fdb1",
"md5": "b4e4448416bc1cd73eaa6384b6813948",
"sha256": "24140a090ea1ac512a2b2f479cc64192fd1d527a7f3627671268d08ed5ac418c"
},
"downloads": -1,
"filename": "weasel-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4e4448416bc1cd73eaa6384b6813948",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 50270,
"upload_time": "2024-05-15T08:52:52",
"upload_time_iso_8601": "2024-05-15T08:52:52.977232Z",
"url": "https://files.pythonhosted.org/packages/2a/87/abd57374044e1f627f0a905ac33c1a7daab35a3a815abfea4e1bafd3fdb1/weasel-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a71a9c522dd61b52939c217925d3e55c95f9348b73a66a956f52608e1e59a2c0",
"md5": "94642a4a7ba97499f03ca1eec48cbca2",
"sha256": "aabc210f072e13f6744e5c3a28037f93702433405cd35673f7c6279147085aa9"
},
"downloads": -1,
"filename": "weasel-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "94642a4a7ba97499f03ca1eec48cbca2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 38417,
"upload_time": "2024-05-15T08:52:54",
"upload_time_iso_8601": "2024-05-15T08:52:54.765824Z",
"url": "https://files.pythonhosted.org/packages/a7/1a/9c522dd61b52939c217925d3e55c95f9348b73a66a956f52608e1e59a2c0/weasel-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-15 08:52:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "explosion",
"github_project": "weasel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "weasel"
}
JSON
