distributaur 0.0.28

Simple task manager and job queue for distributed rendering. Built on celery and redis.

distributaur

A simple way to distribute rendering tasks across multiple machines.

Description

Distributaur distributes rendering using the Celery task queue. The queued tasks are then passed to workers using Redis as a message broker. Once the worker has completed the task, the result is uploaded to Huggingface.

Installation

pip install distributaur

Development

Setup

Clone the repository and navigate to the project directory:

git clone https://github.com/RaccoonResearch/distributaur.git
cd distributaur

Install the required packages:

pip install -r requirements.txt

Install the distributaur package:

python setup.py install

Configuration

Create a .env file in the root directory of your project or set environment variables to create your desired setup:

REDIS_HOST=redis_host
REDIS_PORT=redis_port
REDIS_USER=redis_user
REDIS_PASSWORD=redis_password
VAST_API_KEY=your_vastai_api_key
HF_TOKEN=your_huggingface_token
HF_REPO_ID=your_huggingface_repo
BROKER_POOL_LIMIT=broker_pool_limit

Getting Started

Running an Example Task

To run an example task and see Distributaur in action, you can execute the example script provided in the project:

# To run the example task locally using either a Docker container or a Celery worker
python -m distributaur.example.local

# To run the example task on vast.ai ("kitchen sink" example)
python -m distributaur.example.distributed

This script configures the environment, registers a sample function, dispatches a task, and monitors its execution.

Command Options

• --max_price is the max price (in $/hour) a node can be be rented for.
• --max_nodes is the max number of vast.ai nodes that can be rented.
• --docker_image is the name of the docker image to load to the vast.ai node.
• --module_name is the name of the celery worker
• --number_of_tasks is the number of example tasks that will be added to the queue and done by the workers.

Contributing

Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Citation

@misc{distributaur,
  author = {Raccoon Research},
  title = {distributaur: a simple way to distribute rendering tasks across mulitiple machines},
  year = {2024},
  publisher = {GitHub},
  howpublished = {\url{https://github.com/RaccoonResearch/distributaur}}
}

Contributors