README.md

Modal Examples

This is a collection of examples for Modal. Use these examples to learn Modal and build your own robust and scalable applications.

Usage

First, sign up for a free account at modal.com and follow the setup instructions to install the modal package and set your API key.

The examples are organized into several folders based on their category. You can generally run the files in any folder much like you run ordinary Python programs, with a command like:

modal run 01_getting_started.hello_world

Although these scripts are run on your local machine, they'll communicate with Modal and run in our cloud, spawning serverless containers on demand.

Examples

• 01_getting_started/ through 11_notebooks/ provide a guided tour through Modal's concepts and capabilities.
• misc/ contains uncategorized, miscellaneous examples.

These examples are continuously tested for correctness against Python 3.11.

License

The MIT license.