explosion/projects

🪐 Project Templates

Weasel, previously spaCy projects, 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 project templates require Weasel, which is also included by default with spaCy v3.7+. You can install it from pip with pip install weasel or conda with conda install weasel -c conda-forge. Make sure to use a fresh virtual environment.

See the master branch for the previous version of this repo.

🗃 Categories

🚀 Quickstart

Projects can be used via the weasel CLI, or through the spacy project alias. To find out more about a command, add --help. For detailed instructions, see the Weasel documentation or spaCy projects usage guide.

1. Clone the project template you want to use.

   python -m weasel clone tutorials/ner_fashion_brands
   

2. Install any project requirements.

   cd ner_fashion_brands
   python -m pip install -r requirements.txt
   

3. Fetch assets (data, weights) defined in the project.yml.

   python -m weasel assets
   

4. Run a command defined in the project.yml.

   python -m weasel run preprocess
   

5. Run a workflow of multiple steps in order.

   python -m weasel run all
   

6. Adjust the template for your specific use case, load in your own data, adjust the settings and model and share the result with your team.

👷‍♀️Repository maintanance

To keep the project templates and their documentation up to date, this repo contains several scripts: