Skip to main content

Collection of tasks for running containerized models.

Project description

Build status Lint status Documentation Coverage Code style Version License

Collection of tasks for running containerized models. Designed to be used both in Prefect workflows and as modular, useful pieces of code.

Installation

The collection can be installed using:

pip install container-collection

We recommend using Poetry to manage and install dependencies. To install into your Poetry project, use:

poetry add container-collection

Usage

Prefect workflows

All tasks in this collection are wrapped in a Prefect @task decorator, and can be used directly in a Prefect @flow. Running tasks within a Prefect flow enables you to take advantage of features such as automatically retrying failed tasks, monitoring workflow states, running tasks concurrently, deploying and scheduling flows, and more.

from prefect import flow
from container_collection.<module_name> import <task_name>

@flow
def run_flow():
    <task_name>()

if __name__ == "__main__":
    run_flow()

See cell-abm-pipeline for examples of using tasks from different collections to build a pipeline for simulating and analyzing agent-based model data.

Individual tasks

Not all use cases require a full workflow. Tasks in this collection can be used without the Prefect @task decorator by simply importing directly from the module:

from container_collection.<module_name>.<task_name> import <task_name>

def main():
    <task_name>()

if __name__ == "__main__":
    main()

or using the .fn() method:

from container_collection.<module_name> import <task_name>

def main():
    <task_name>.fn()

if __name__ == "__main__":
    main()

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

container_collection-1.1.0.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

container_collection-1.1.0-py3-none-any.whl (23.7 kB view details)

Uploaded Python 3

File details

Details for the file container_collection-1.1.0.tar.gz.

File metadata

  • Download URL: container_collection-1.1.0.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for container_collection-1.1.0.tar.gz
Algorithm Hash digest
SHA256 cdc1303c3cbdcc3929c5063c9afd7fedb81142e8779dd1f27f75f7cfc05df24c
MD5 b768545e5fa4f75fc6dd5784c032989f
BLAKE2b-256 22c05139c70748b6a42a8766cdaa3a6834bfe0ac27c857ca9200e2b3c8d2acf9

See more details on using hashes here.

File details

Details for the file container_collection-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for container_collection-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a984a48b5445d5520ac66181d67f9ba365459df2e36e53c78380cefb5f5fa0ff
MD5 92c1bcfc474b557de81f5da1cb21e351
BLAKE2b-256 7b5fce98766a0ab51f228ba74b5b2e74379d94984aee0e880b0ba8cfded92c75

See more details on using hashes here.

Supported by

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