Scheduled Job

Beam apps can be run on a schedule with the schedule decorator.

from beam import App, Volume, Output

app = App(
    name="my-app",
    volumes=[
        Volume(name="files", path="./files"),
    ],
)


@app.schedule(when="every 5m")
def handler():
    return

schedule supports cron and string expressions. You can use Crontab to help generate expressions.

​

Testing your function

You can create a one-off run of your function with beam run:

beam run app.py:your_function

You can also pass in JSON payloads by using the -d flag:

beam run app.py:your_function -d '{"your_key": "your_value"}'

​

Deploying a Scheduled Job

To deploy the app, enter your shell and run this command from the working directory:

beam deploy app.py:your_function

After running this command, you’ll see some logs in the console that show the progress of your deployment.

user@MacBook conversational-ai % beam deploy app.py
 i  Copying files in workspace './'...
 ✓  Done.
 i  Adding python requirements...
 i  	langchain
 i  	openai
 i  	unstructured
 i  	pdf2image
 i  	tabulate
 ✓  Done.
 i  Using cached image.
 ✓  <conversational-ai> deployed successfully! 🎉
 i  ID: 64c131ff2628c00009ebefc8
 i  Version: 6
 i  Trigger type: schedule
 i  CPU: 4000m
 i  GPU: T4
 i  Memory: 16Gi
 i  Runtime: python3.8
 i  Send requests to: https://apps.beam.cloud/kia35
 i  View deployment status at: https://www.beam.cloud/apps/kia35/deployment/64c131ff2628c00009ebefc8/logs

​

Cron Expression Cheatsheet

Beam supports standard cron expressions. Here are a few examples:

​

String Expression Cheatsheet

You can also write expressions using a friendlier human-readable syntax, for intervals up to 1 hour.

​

Further Reading