Modal logo
GuideReference

Overview

Introduction Example: Hello, world Tutorial: A simple web scraper

Custom container images

Custom container images Private registries

GPUs and other resources

GPU acceleration Reserving CPU and memory Example: Run a 40-billion parameter LLM (Falcon-40B)

Scaling out

Scaling out Example: Face detection on YouTube videos

Secrets and environment variables

Secrets Example: Write to Google Sheets

Deployment

Managing deployments Invoke deployed functions

Scheduling and cron jobs

Scheduling remote cron jobs Example: Hacker News Slackbot

Web endpoints

Web endpoints Streaming web endpoints Web endpoint URLs Request timeouts Example: Document OCR job queue Example: Document OCR web app

Sharing data

Passing local data Shared volumes

Deep learning and AI examples

Fast Stable diffusion Replace your CEO with an LLM Voice Chat with LLMs Parallel podcast transcription using Whisper Pet Art using Dreambooth Question-answering with LangChain Play with ControlNet Misc examples

Examples using popular libraries

DuckDB: Analyze NYC taxi data in parallel Blender: Distributed 3D rendering SQLite: Publish explorable data with Datasette Y! Finance: Stock prices in parallel

Reliability and robustness

Failures and retries Preemption Timeouts Troubleshooting

Security

Security at Modal

Other topics

Developing and debugging Cold start performance Workspaces Notebooks support Asynchronous usage Global variables Container lifecycle and parameters Apps, stubs, and entrypoints Useful snippets Example: Algolia docsearch crawler

Workspaces

After having signed up to Modal, you’ve automatically received a Personal Workspace that you can use to run and deploy personal apps. To deploy collaborate with others, however, you can create or join additional Workspaces.

Create a Workspace

Modal Workspaces are always associated with a GitHub organization. On the settings page, every GitHub organization to which you’ve granted Modal access will be listed.

view of workspaces user interface

If you don’t see the GitHub organization you’re looking for, click “Refresh GitHub Organizations”. This will retrieve from GitHub all organizations of which you are a member and update the displayed list. (If you are an outside collaborator with a GitHub organization, you must be upgraded to an organization member.)

Within the displayed list of organizations, you can click a list item’s “create” button to create a new Modal Workspace.

Inviting new Workspace members

To invite a new Workspace member, first switch your dashboard environment to an organization Workspace. Navigate to the settings page and under the “Invite Member” section enter the email address of the person you would like to invite. Click “invite” to send the invite. Invited members must be a member of the active Workspaces’s associated GitHub organization.

The invited person will receive an email with a link to join your Workspace. The email link will also allow them to sign up to Modal and create a Personal Workspace if they do not have one already.

Create a token for a Workspace

To interact with a Workspace’s resources programmatically, you need to add an API token for that Workspace. Existing API tokens are displayed on the settings page and new API tokens can be added for a particular Workspace.

After adding a token for a Workspace to your Modal config file you can activate that Workspace’s profile using the CLI (see below).

For more information on API token management see the documentation about configuration.

Switching active Workspace

When on the dashboard or using the CLI, the active profile determines which personal or organizational Workspace is associated with your actions.

Dashboard

You can switch between organization Workspaces and your Personal Workspace by using the workspace selector at the top of the dashboard.

CLI

To switch the Workspace associated with CLI commands, use modal profile activate.

Leaving a Workspace

To leave a Workspace, navigate to the settings page and click “leave” on a listed Workspace.