Skip to main content

A task queue system for lab experiments

Project description

Make your ML experiment wrapper scripts smarter with...

Labtasker

InstallTutorial / DemoDocumentationFAQsReleases

unit-test-matrix codecov Python version PyPI

🌟 Labtasker makes ML experiment wrapper scripts smarter with task prioritization, failure handling, halfway resume and more: just change 1 line of code.

If you like our project, please give us a star ⭐ on GitHub for latest update.

✨ When and Where to Use

TLDR: Replace for loops in your experiment wrapper script with labtasker to enable features like experiment parallelization, dynamic task prioritization, failure handling, halfway resume, and more.

comparison

🐳 For detailed examples and concepts, check out the documentation.

🧪️ A Quick Demo

This demo shows how to easily submit task arguments and run jobs in parallel.

It also features an event listener to monitor task execution in real-time and automate workflows, such as sending emails on task failure.

demo

For more detailed steps, please refer to the content in the Tutorial / Demo.

⚡️ Features

  • ⚙️ Easy configuration and setup.
  • 🧩 Versatile and minimalistic design.
  • 🔄 Supports both CLI and Python API for task scheduling.
  • 🔌 Customizable plugin system.

🔮 Supercharge Your ML Experiments with Labtasker

  • ⚡️ Effortless Parallelization: Distribute tasks across multiple GPU workers with just a few lines of code.
  • 🛡️ Intelligent Failure Management: Automatically capture exceptions, retry failed tasks, and maintain detailed error logs.
  • 🔄 Seamless Recovery: Resume failed experiments with a single command - no more scavenging through logs or directories.
  • 🎯 Real-time Prioritization: Changed your mind about experiment settings? Instantly cancel, add, or reschedule tasks without disrupting existing ones.
  • 🤖 Workflow Automation: Set up smart event triggers for email notifications or task workflow based on FSM transition events.
  • 📊 Streamlined Logging: All stdout/stderr automatically organized in .labtasker/logs - zero configuration required.
  • 🧩 Extensible Plugin System: Create custom command combinations or leverage community plugins to extend functionality.

🛠️ Installation

[!NOTE] You need a running Labtasker server to use the client tools. Simply use the installed Python CLI labtasker-server serve or use docker-compose to deploy the server. See deployment instructions.

1. Install via PyPI

# Install with optional bundled plugins
pip install 'labtasker[plugins]'

2. Install the Latest Version from GitHub

pip install git+https://github.com/luocfprime/labtasker.git

🚀 Quick Start

Use the following command to launch a labtasker server in the background:

labtasker-server serve &

Use the following command to quickly setup a labtasker queue for your project:

labtasker init

Then, use labtasker submit to submit tasks and use labtasker loop to run tasks across any number of workers.

[!TIP] If you think manually writing 2 scripts for submit and run is laborious, you can checkout the labtasker-plugin-script-generate. It automatically generate 2 scripts based on the script you provided.

📚 Documentation

For detailed information on demo, tutorial, deployment, usage, please refer to the documentation.

🔒 License

See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

labtasker-0.2.11.tar.gz (294.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

labtasker-0.2.11-py3-none-any.whl (272.4 kB view details)

Uploaded Python 3

File details

Details for the file labtasker-0.2.11.tar.gz.

File metadata

  • Download URL: labtasker-0.2.11.tar.gz
  • Upload date:
  • Size: 294.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for labtasker-0.2.11.tar.gz
Algorithm Hash digest
SHA256 e279829be8bdfb3395cc2ff24ac8b4a3ba78767442f0ed80fa97fb1fcee80140
MD5 5dea363f59156c69832c6af509b7bdbd
BLAKE2b-256 75585195801ff708a34eedb0524df1e1dec06c85960b3c6228f8b4ca23bf3ad9

See more details on using hashes here.

Provenance

The following attestation bundles were made for labtasker-0.2.11.tar.gz:

Publisher: release.yml on luocfprime/labtasker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file labtasker-0.2.11-py3-none-any.whl.

File metadata

  • Download URL: labtasker-0.2.11-py3-none-any.whl
  • Upload date:
  • Size: 272.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for labtasker-0.2.11-py3-none-any.whl
Algorithm Hash digest
SHA256 e45616bad7e5efd25cba2f6335ccc549d6ef402946925cc7deab37e77c9d04c7
MD5 a9d37818198173941d2f90d810f92eda
BLAKE2b-256 b16f48580701bb5c2ce710363a242ffb5673ececefd1c1f9b5a2eee88261bd35

See more details on using hashes here.

Provenance

The following attestation bundles were made for labtasker-0.2.11-py3-none-any.whl:

Publisher: release.yml on luocfprime/labtasker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page