prefect-memory-profiling

Welcome!

A collection of Prefect Tasks for different varieties of profiling

Getting Started

Python setup

Requires an installation of Python 3.7+.

We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.

These tasks are designed to work with Prefect 2.0. For more information about how to use Prefect, please refer to the Prefect documentation.

Installation

Install prefect-memory-profiling with pip:

pip install prefect-memory-profiling

Write and run a flow

from prefect import flow
from prefect_memory_profiling.tasks import (
    goodbye_prefect_memory_profiling,
    hello_prefect_memory_profiling,
)


@flow
def example_flow():
    hello_prefect_memory_profiling
    goodbye_prefect_memory_profiling

example_flow()

Resources

If you encounter any bugs while using prefect-memory-profiling, feel free to open an issue in the prefect-memory-profiling repository.

If you have any questions or issues while using prefect-memory-profiling, you can find help in either the Prefect Discourse forum or the Prefect Slack community.

Development

If you'd like to install a version of prefect-memory-profiling for development, clone the repository and perform an editable install with pip:

git clone https://github.com/zzstoatzz/prefect-memory-profiling.git

cd prefect-memory-profiling/

pip install -e ".[dev]"

# Install linting pre-commit hooks
pre-commit install