Core Concepts

One-off Python functions, like training runs, scraping, or batch jobs.

from beam import function

@function()
def handler():
    return {}

if __name__ == "__main__":
    # Runs locally
    handler.local()
    # Runs on the cloud
    handler.remote()

Functions that run based on a schedule you specify.

from beam import schedule

@schedule(when="every 1d")
def handler():
    return {}

if __name__ == "__main__":
    # Runs locally
    handler.local()
    # Runs on the cloud
    handler.remote()

You’ll run your functions like a normal Python function: python app.py. Even though it feels like the code is running locally, it’s running on a container in the cloud.

Synchronous REST API endpoints, for tasks that run in 60s or less.

from beam import endpoint

@endpoint(name="quickstart")
def handler():
  return {}

Asynchronous REST API endpoints, for heavier tasks that take a long time to run.

from beam import task_queue

@task_queue(name="quickstart")
def handler():
  print(48393 * 39383)

Beam provides a temporary cloud environment to test your code.

These environments hot-reload with your code changes. You can test your workflow end-to-end before deploying to production.

beam serve app.py:handler

When you’re ready to deploy a persistent endpoint, you’ll use beam deploy:

beam deploy app.py:handler