mirror of
https://github.com/hanzoai/skills.git
synced 2026-11-19 00:47:36 +00:00
hanzoskills.com/llms.txt now opens with the install line, the API reference index and the company index, so an agent that lands on any one of the three can find the rest. robots.txt claimed 537 documents while llms.txt counts 920. The number is gone from robots.txt; llms.txt derives it. public/ is regenerated from scripts/site.py, which it had fallen behind: the copy-prompt menu and agent bar were in the generator and not in the committed pages. tests/site.mjs passes against the result. Co-authored-by: Hanzo Dev <[email protected]>
668 lines
26 KiB
HTML
668 lines
26 KiB
HTML
<!doctype html>
|
|
<html lang="en"><head>
|
|
<meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>modal-functions-basics</title>
|
|
<meta name="color-scheme" content="dark">
|
|
<style>
|
|
/* Committed to one visual world: a dark instrument panel. No light variant —
|
|
the dot field and the hairline rules only read on black, and a naive
|
|
inversion would wash both out. Every colour is painted explicitly so the page
|
|
never borrows a host background. */
|
|
@font-face{font-family:'Zen';src:url('/fonts/Zen-Variable.woff2') format('woff2');font-weight:100 900;font-style:normal;font-display:swap}
|
|
@font-face{font-family:'Zen';src:url('/fonts/Zen-Italic-Variable.woff2') format('woff2');font-weight:100 900;font-style:italic;font-display:swap}
|
|
@font-face{font-family:'Zen Mono';src:url('/fonts/ZenMono-Variable.woff2') format('woff2');font-weight:100 900;font-style:normal;font-display:swap}
|
|
@font-face{font-family:'Zen Mono';src:url('/fonts/ZenMono-Italic-Variable.woff2') format('woff2');font-weight:100 900;font-style:italic;font-display:swap}
|
|
@font-face{font-family:'Zen Pixel Square';src:url('/fonts/ZenPixel-Square.woff2') format('woff2');font-style:normal;font-display:swap}
|
|
|
|
:root{
|
|
--ink:#f4f4f2; --soft:#9c9c98; --faint:#6a6a66; --ground:#000; --panel:#0a0a0a;
|
|
--line:#232323; --line-hi:#3a3a3a; --accent:#f4f4f2;
|
|
--font-zen-sans:'Zen',-apple-system,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif;
|
|
--font-zen-mono:'Zen Mono',ui-monospace,"SF Mono",SFMono-Regular,Menlo,Consolas,monospace;
|
|
--font-zen-pixel-square:'Zen Pixel Square',monospace;
|
|
--mono:var(--font-zen-mono);
|
|
--sans:var(--font-zen-sans);
|
|
/* Controls are pills and surfaces are soft, as on hanzo.ai. */
|
|
--r:999px; --r-soft:14px;
|
|
}
|
|
*{box-sizing:border-box}
|
|
html{-webkit-text-size-adjust:100%}
|
|
body{margin:0;background:var(--ground);color:var(--ink);font-family:var(--sans);
|
|
font-size:16px;line-height:1.65;-webkit-font-smoothing:antialiased}
|
|
.wrap{max-width:60rem;margin:0 auto;padding:0 1.75rem}
|
|
|
|
/* The dot field. A halftone made of one repeating radial-gradient, faded out
|
|
along the diagonal by a mask so it reads as a wave rather than wallpaper. */
|
|
/* No overflow clip here: the dot field is inset to the box already, and a clip
|
|
would cut off the copy-prompt menu. */
|
|
.hero{position:relative;border-bottom:1px solid var(--line)}
|
|
.hero::before{content:"";position:absolute;inset:0;
|
|
background-image:radial-gradient(var(--line-hi) 1px, transparent 1px);
|
|
background-size:7px 7px;
|
|
-webkit-mask-image:linear-gradient(115deg,#000 0%,rgba(0,0,0,.55) 38%,transparent 72%);
|
|
mask-image:linear-gradient(115deg,#000 0%,rgba(0,0,0,.55) 38%,transparent 72%);
|
|
pointer-events:none}
|
|
.hero .wrap{position:relative;padding-top:5.5rem;padding-bottom:4rem}
|
|
|
|
nav{border-bottom:1px solid var(--line)}
|
|
nav .in{max-width:60rem;margin:0 auto;padding:1.1rem 1.75rem;display:flex;
|
|
justify-content:space-between;align-items:center;gap:1rem}
|
|
.brand{font-family:var(--mono);font-size:.85rem;letter-spacing:.14em;
|
|
text-transform:uppercase;color:var(--ink);text-decoration:none;
|
|
display:inline-flex;align-items:center;gap:.6rem}
|
|
.brand i{font-style:normal;color:var(--faint)}
|
|
.mark{width:1.15em;height:1.15em;display:block;flex:0 0 auto}
|
|
nav a.up{font-family:var(--mono);font-size:.72rem;letter-spacing:.14em;
|
|
text-transform:uppercase;color:var(--soft);text-decoration:none}
|
|
nav a.up:hover{color:var(--ink)}
|
|
|
|
h1{font-family:var(--mono);font-size:clamp(2rem,5.4vw,3.4rem);line-height:1.12;
|
|
letter-spacing:-.02em;margin:0 0 1.1rem;font-weight:500;text-wrap:balance}
|
|
h1 em{font-style:normal;color:var(--faint)}
|
|
.lede{color:var(--soft);font-size:1.05rem;max-width:52ch;margin:0 0 2.25rem}
|
|
|
|
.btns{display:flex;flex-wrap:wrap;gap:.7rem;margin:0 0 .5rem;align-items:center}
|
|
.btn{display:inline-flex;align-items:center;gap:.5rem;font-family:var(--mono);
|
|
font-size:.72rem;letter-spacing:.14em;text-transform:uppercase;
|
|
padding:.8rem 1.4rem;border:1px solid var(--line-hi);border-radius:var(--r);
|
|
color:var(--ink);text-decoration:none;background:transparent;cursor:pointer;
|
|
line-height:1.2;font-weight:400}
|
|
.btn:hover{background:#141414;text-decoration:none;border-color:var(--soft)}
|
|
.btn.solid{background:var(--ink);color:#000;border-color:var(--ink)}
|
|
.btn.solid:hover{background:#d8d8d4}
|
|
.btn .chev{width:.7em;height:.7em;flex:0 0 auto;transition:transform .15s ease}
|
|
.btn[aria-expanded="true"] .chev{transform:rotate(180deg)}
|
|
|
|
/* Copy-prompt selector. Each row copies the prompt for its own target. */
|
|
.copy{position:relative;display:inline-flex}
|
|
.menu{position:absolute;top:calc(100% + .5rem);left:0;z-index:20;min-width:21rem;
|
|
background:var(--panel);border:1px solid var(--line-hi);border-radius:var(--r-soft);
|
|
padding:.4rem;display:flex;flex-direction:column;
|
|
box-shadow:0 12px 32px rgba(0,0,0,.75)}
|
|
.menu[hidden]{display:none}
|
|
.mi{display:flex;align-items:center;gap:.7rem;width:100%;text-align:left;
|
|
padding:.62rem .8rem;border:0;border-radius:calc(var(--r-soft) - .35rem);
|
|
background:transparent;color:var(--ink);font-family:var(--mono);font-size:.76rem;
|
|
letter-spacing:.04em;text-decoration:none;cursor:pointer;line-height:1.3;
|
|
white-space:nowrap}
|
|
.mi:hover,.mi:focus-visible{background:#181818;outline:none}
|
|
.mi .mark{width:1.05rem;height:1.05rem;color:var(--soft)}
|
|
.mi:hover .mark{color:var(--ink)}
|
|
.mi u{margin-left:auto;color:var(--faint);text-decoration:none;font-size:.68rem;
|
|
letter-spacing:.1em;text-transform:uppercase}
|
|
|
|
/* Works-with bar: one scrolling row, name and mark per agent. */
|
|
.strip{border-bottom:1px solid var(--line);background:var(--panel)}
|
|
.strip .in{max-width:60rem;margin:0 auto;padding:.9rem 1.75rem;display:flex;
|
|
align-items:center;gap:1.25rem;font-family:var(--mono);font-size:.72rem;
|
|
letter-spacing:.1em;text-transform:uppercase;color:var(--faint)}
|
|
.strip b{color:var(--soft);font-weight:400;flex:0 0 auto;
|
|
border-right:1px solid var(--line);padding-right:1.25rem;align-self:stretch;
|
|
display:flex;align-items:center}
|
|
.bar{display:flex;align-items:center;gap:.5rem;flex:1 1 auto;min-width:0;
|
|
overflow-x:auto;scrollbar-width:none;scroll-snap-type:x proximity;
|
|
-webkit-overflow-scrolling:touch;
|
|
-webkit-mask-image:linear-gradient(90deg,#000 calc(100% - 3rem),transparent);
|
|
mask-image:linear-gradient(90deg,#000 calc(100% - 3rem),transparent)}
|
|
.bar::-webkit-scrollbar{display:none}
|
|
.agent{display:inline-flex;align-items:center;gap:.45rem;flex:0 0 auto;
|
|
padding:.4rem .85rem;border:1px solid var(--line);border-radius:var(--r);
|
|
color:var(--soft);white-space:nowrap;scroll-snap-align:start;
|
|
text-decoration:none;background:var(--ground)}
|
|
.agent:hover{color:var(--ink);border-color:var(--line-hi);text-decoration:none}
|
|
.agent .mark{width:.95rem;height:.95rem}
|
|
|
|
h2{font-family:var(--mono);font-size:1.1rem;letter-spacing:-.01em;margin:2.75rem 0 .75rem;font-weight:500}
|
|
h3{font-size:1rem;margin:2rem 0 .5rem;font-weight:600}
|
|
h4,h5,h6{font-size:.94rem;margin:1.5rem 0 .5rem;font-weight:600}
|
|
p{margin:0 0 1rem;max-width:70ch}
|
|
ul,ol{margin:0 0 1rem;padding-left:1.35rem;max-width:70ch}
|
|
li{margin:.22rem 0}
|
|
a{color:var(--ink);text-decoration:underline;text-underline-offset:3px;
|
|
text-decoration-color:var(--line-hi)}
|
|
a:hover{text-decoration-color:var(--ink)}
|
|
a:focus-visible{outline:1px solid var(--ink);outline-offset:3px}
|
|
code{font-family:var(--mono);font-size:.85em;background:var(--panel);
|
|
border:1px solid var(--line);border-radius:5px;padding:.1em .36em}
|
|
pre{background:var(--panel);border:1px solid var(--line);padding:1rem 1.1rem;
|
|
border-radius:var(--r-soft);overflow-x:auto;margin:0 0 1.25rem}
|
|
pre code{background:none;border:0;padding:0;font-size:.82rem;line-height:1.7}
|
|
blockquote{margin:0 0 1rem;padding-left:1rem;border-left:1px solid var(--line-hi);color:var(--soft)}
|
|
hr{border:0;border-top:1px solid var(--line);margin:2.5rem 0}
|
|
table{border-collapse:collapse;width:100%;margin:0 0 1.25rem;font-size:.92rem;
|
|
display:block;overflow-x:auto}
|
|
th,td{border:1px solid var(--line);padding:.5rem .7rem;text-align:left}
|
|
|
|
.curl{display:block;background:var(--panel);border:1px solid var(--line);
|
|
border-radius:var(--r-soft);padding:.95rem 1.1rem;font-family:var(--mono);
|
|
font-size:.8rem;color:var(--soft);overflow-x:auto;margin:0 0 2.5rem;
|
|
white-space:pre;line-height:1.9}
|
|
.curl b{color:var(--ink);font-weight:400}
|
|
.curl i{font-style:normal;color:var(--faint)}
|
|
|
|
/* index */
|
|
#q{width:100%;padding:.85rem 1.2rem;font-family:var(--mono);font-size:.85rem;color:var(--ink);
|
|
background:var(--panel);border:1px solid var(--line);border-radius:var(--r);margin:0 0 .6rem}
|
|
#q::placeholder{color:var(--faint);text-transform:uppercase;letter-spacing:.1em;font-size:.72rem}
|
|
#q:focus{outline:none;border-color:var(--soft)}
|
|
#count{color:var(--faint);font-family:var(--mono);font-size:.72rem;letter-spacing:.1em;
|
|
text-transform:uppercase;margin:0 0 2rem}
|
|
.cat{margin:2.5rem 0 .5rem;font-family:var(--mono);font-size:.7rem;letter-spacing:.16em;
|
|
text-transform:uppercase;color:var(--faint);border-bottom:1px solid var(--line);
|
|
padding-bottom:.45rem}
|
|
.row{display:block;padding:.6rem .9rem;margin:0 -.9rem;border-bottom:1px solid var(--line);
|
|
border-radius:var(--r-soft);text-decoration:none}
|
|
.row:hover{background:#0a0a0a}
|
|
.nm{font-family:var(--mono);font-size:.84rem;color:var(--ink);display:block}
|
|
.ds{color:var(--soft);font-size:.9rem;display:block;margin-top:.12rem}
|
|
footer{margin-top:4rem;padding:2rem 0 4rem;border-top:1px solid var(--line);
|
|
color:var(--faint);font-size:.85rem}
|
|
footer a{color:var(--soft)}
|
|
.fmap{display:grid;gap:1.75rem;grid-template-columns:repeat(auto-fit,minmax(11rem,1fr));
|
|
margin:0 0 2rem;font-size:.85rem}
|
|
.fmap b{display:block;font-family:var(--mono);font-size:.68rem;letter-spacing:.16em;
|
|
text-transform:uppercase;color:var(--faint);font-weight:400;margin:0 0 .6rem;
|
|
border-bottom:1px solid var(--line);padding-bottom:.4rem}
|
|
.fmap a{display:inline-block;color:var(--ink);text-decoration:none;margin:.3rem .35rem 0 0}
|
|
.fmap a:hover{text-decoration:underline}
|
|
.fmap div{color:var(--faint);line-height:1.5}
|
|
.fend{border-top:1px solid var(--line);padding-top:1.25rem;font-size:.82rem}
|
|
|
|
@media (max-width:640px){
|
|
.hero .wrap{padding-top:3.25rem;padding-bottom:2.75rem}
|
|
.btns{gap:.5rem}
|
|
.btn{padding:.75rem 1.15rem;font-size:.68rem}
|
|
.copy,.copy .btn{width:100%;justify-content:center}
|
|
.menu{left:0;right:0;min-width:0}
|
|
.strip .in{flex-direction:column;align-items:flex-start;gap:.6rem;padding:.9rem 1.75rem}
|
|
.strip b{border-right:0;padding-right:0}
|
|
.bar{width:100%}
|
|
}
|
|
</style>
|
|
<link rel="alternate" type="text/markdown" href="/modal-functions-basics.md">
|
|
|
|
<link rel="icon" href="/favicon.svg">
|
|
<link rel="canonical" href="https://hanzoskills.com/modal-functions-basics">
|
|
</head>
|
|
<!-- Reading this with a machine? Every page here is also plain markdown.
|
|
This one: https://hanzoskills.com/modal-functions-basics.md
|
|
Index: https://hanzoskills.com/llms.txt
|
|
Corpus: https://hanzoskills.com/all.md
|
|
Append .md to any path for the markdown twin. -->
|
|
<body>
|
|
<nav><div class="in">
|
|
<a class="brand" href="/"><svg class="mark" viewBox="0 0 67 67" fill="currentColor" aria-hidden="true"><path d="M22.21 67V44.6369H0V67H22.21Z"/><path d="M66.7038 22.3184H22.2534L0.0878906 44.6367H44.4634L66.7038 22.3184Z"/><path d="M22.21 0H0V22.3184H22.21V0Z"/><path d="M66.7198 0H44.5098V22.3184H66.7198V0Z"/><path d="M66.7198 67V44.6369H44.5098V67H66.7198Z"/></svg> HANZO<i>SKILLS</i></a>
|
|
<a class="up" href="/">All skills</a>
|
|
</div></nav>
|
|
|
|
<div class="wrap">
|
|
<h1>modal-functions-basics</h1><p class="lede">Building serverless functions on Modal.com</p><h1>Modal Functions Basics</h1>
|
|
<p><strong>Use this skill when:</strong></p>
|
|
<ul><li>Building serverless functions on Modal.com</li><li>Defining Modal app structure and decorators</li><li>Understanding function lifecycle and execution</li><li>Working with Modal's Python SDK</li><li>Creating basic serverless endpoints</li></ul>
|
|
<h2>App Structure</h2>
|
|
<h3>Basic App Definition</h3>
|
|
<p>Define Modal apps with decorators:</p>
|
|
<pre><code class="lang-python">import modal
|
|
|
|
# Create app instance
|
|
app = modal.App("my-app")
|
|
|
|
# Define simple function
|
|
@app.function()
|
|
def hello(name: str) -> str:
|
|
return f"Hello, {name}!"
|
|
|
|
# Local invocation
|
|
@app.local_entrypoint()
|
|
def main():
|
|
result = hello.remote("World")
|
|
print(result)</code></pre>
|
|
<h3>Function Decorators</h3>
|
|
<p>Use <code>@app.function()</code> for serverless functions:</p>
|
|
<pre><code class="lang-python">@app.function()
|
|
def simple_function():
|
|
"""Basic function with no special configuration"""
|
|
return "Hello from Modal!"
|
|
|
|
# With timeout
|
|
@app.function(timeout=300) # 5 minutes
|
|
def long_running_task():
|
|
import time
|
|
time.sleep(200)
|
|
return "Done!"
|
|
|
|
# With memory configuration
|
|
@app.function(memory=2048) # 2GB RAM
|
|
def memory_intensive():
|
|
large_array = [0] * 10_000_000
|
|
return sum(large_array)
|
|
|
|
# With CPU configuration
|
|
@app.function(cpu=4)
|
|
def parallel_processing():
|
|
import multiprocessing
|
|
pool = multiprocessing.Pool(4)
|
|
# Parallel work
|
|
return "Processed"</code></pre>
|
|
<h2>Image Configuration</h2>
|
|
<h3>Base Images</h3>
|
|
<p>Configure runtime environment:</p>
|
|
<pre><code class="lang-python"># Debian slim base
|
|
image = modal.Image.debian_slim()
|
|
|
|
# Ubuntu base
|
|
image = modal.Image.ubuntu()
|
|
|
|
# Specific Python version
|
|
image = modal.Image.debian_slim(python_version="3.11")
|
|
|
|
# Use image in function
|
|
@app.function(image=image)
|
|
def my_function():
|
|
return "Using custom image"</code></pre>
|
|
<h3>Installing Packages</h3>
|
|
<p>Install Python packages with uv (recommended):</p>
|
|
<pre><code class="lang-python"># Single package
|
|
image = modal.Image.debian_slim().uv_pip_install("requests")
|
|
|
|
# Multiple packages
|
|
image = modal.Image.debian_slim().uv_pip_install(
|
|
"numpy",
|
|
"pandas",
|
|
"scikit-learn"
|
|
)
|
|
|
|
# With specific versions
|
|
image = modal.Image.debian_slim().uv_pip_install(
|
|
"torch==2.1.0",
|
|
"transformers==4.35.0"
|
|
)
|
|
|
|
# From requirements.txt
|
|
image = modal.Image.debian_slim().uv_pip_install_from_requirements(
|
|
"requirements.txt"
|
|
)
|
|
|
|
@app.function(image=image)
|
|
def ml_inference(text: str):
|
|
import torch
|
|
from transformers import pipeline
|
|
# ML code
|
|
return result</code></pre>
|
|
<h3>System Dependencies</h3>
|
|
<p>Install system packages:</p>
|
|
<pre><code class="lang-python"># Install system packages
|
|
image = (
|
|
modal.Image.debian_slim()
|
|
.apt_install("ffmpeg", "libsm6", "libxext6")
|
|
.uv_pip_install("opencv-python")
|
|
)
|
|
|
|
@app.function(image=image)
|
|
def process_video(video_path: str):
|
|
import cv2
|
|
# Video processing
|
|
return "Processed"</code></pre>
|
|
<h3>Custom Commands</h3>
|
|
<p>Run custom setup commands:</p>
|
|
<pre><code class="lang-python">image = (
|
|
modal.Image.debian_slim()
|
|
.uv_pip_install("torch")
|
|
.run_commands(
|
|
"mkdir -p /models",
|
|
"wget https://example.com/model.bin -O /models/model.bin"
|
|
)
|
|
)
|
|
|
|
@app.function(image=image)
|
|
def use_model():
|
|
model_path = "/models/model.bin"
|
|
# Use preloaded model
|
|
return result</code></pre>
|
|
<h2>Function Invocation Patterns</h2>
|
|
<h3>Remote Invocation</h3>
|
|
<p>Call functions from Python code:</p>
|
|
<pre><code class="lang-python">@app.function()
|
|
def process_item(item_id: int) -> dict:
|
|
# Processing logic
|
|
return {"id": item_id, "status": "processed"}
|
|
|
|
@app.local_entrypoint()
|
|
def main():
|
|
# Synchronous call (waits for result)
|
|
result = process_item.remote(42)
|
|
print(result)
|
|
|
|
# Multiple calls
|
|
results = []
|
|
for i in range(10):
|
|
result = process_item.remote(i)
|
|
results.append(result)</code></pre>
|
|
<h3>Parallel Execution</h3>
|
|
<p>Run functions concurrently:</p>
|
|
<pre><code class="lang-python">@app.function()
|
|
def process_item(item: dict) -> dict:
|
|
import time
|
|
time.sleep(2) # Simulate work
|
|
return {"id": item["id"], "processed": True}
|
|
|
|
@app.local_entrypoint()
|
|
def main():
|
|
items = [{"id": i} for i in range(100)]
|
|
|
|
# Sequential - takes 200 seconds
|
|
results = [process_item.remote(item) for item in items]
|
|
|
|
# Parallel - much faster
|
|
results = list(process_item.map(items))
|
|
print(f"Processed {len(results)} items")</code></pre>
|
|
<h3>Spawning Functions</h3>
|
|
<p>Use <code>.spawn()</code> for fire-and-forget:</p>
|
|
<pre><code class="lang-python">@app.function()
|
|
def send_notification(user_id: int, message: str):
|
|
# Send notification (don't need to wait)
|
|
import requests
|
|
requests.post(
|
|
"https://notifications.example.com/send",
|
|
json={"user_id": user_id, "message": message}
|
|
)
|
|
|
|
@app.function()
|
|
def process_order(order_id: int):
|
|
# Process order
|
|
order = get_order(order_id)
|
|
process(order)
|
|
|
|
# Spawn notification (don't wait)
|
|
send_notification.spawn(order.user_id, "Order processed!")
|
|
|
|
return {"status": "complete"}</code></pre>
|
|
<h2>Local Entrypoints</h2>
|
|
<h3>CLI Interface</h3>
|
|
<p>Create command-line interfaces:</p>
|
|
<pre><code class="lang-python">@app.local_entrypoint()
|
|
def main(name: str = "World"):
|
|
"""
|
|
Simple greeting CLI
|
|
|
|
Usage:
|
|
modal run app.py --name Alice
|
|
"""
|
|
result = hello.remote(name)
|
|
print(result)
|
|
|
|
# Multiple entrypoints
|
|
@app.local_entrypoint()
|
|
def process():
|
|
"""Process all pending items"""
|
|
items = get_pending_items()
|
|
results = list(process_item.map(items))
|
|
print(f"Processed {len(results)} items")
|
|
|
|
@app.local_entrypoint()
|
|
def status():
|
|
"""Check system status"""
|
|
stats = get_stats.remote()
|
|
print(f"Status: {stats}")</code></pre>
|
|
<h2>Container Lifecycle</h2>
|
|
<h3>Container Reuse</h3>
|
|
<p>Understand warm vs cold starts:</p>
|
|
<pre><code class="lang-python"># Global state persists across invocations in same container
|
|
model = None
|
|
|
|
@app.function()
|
|
def predict(text: str):
|
|
global model
|
|
|
|
# Load model once per container
|
|
if model is None:
|
|
print("Loading model (cold start)")
|
|
from transformers import pipeline
|
|
model = pipeline("sentiment-analysis")
|
|
|
|
# Reuse loaded model (warm start)
|
|
return model(text)</code></pre>
|
|
<h3>Function Context</h3>
|
|
<p>Use <code>@enter</code> and <code>@exit</code> for lifecycle hooks:</p>
|
|
<pre><code class="lang-python">@app.cls()
|
|
class ModelInference:
|
|
@modal.enter()
|
|
def load_model(self):
|
|
"""Called once when container starts"""
|
|
print("Loading model...")
|
|
from transformers import pipeline
|
|
self.model = pipeline("sentiment-analysis")
|
|
print("Model loaded")
|
|
|
|
@modal.method()
|
|
def predict(self, text: str):
|
|
"""Called for each request"""
|
|
return self.model(text)
|
|
|
|
@modal.exit()
|
|
def cleanup(self):
|
|
"""Called when container shuts down"""
|
|
print("Cleaning up...")
|
|
self.model = None
|
|
|
|
# Usage
|
|
@app.local_entrypoint()
|
|
def main():
|
|
inference = ModelInference()
|
|
results = inference.predict.map([
|
|
"I love this!",
|
|
"This is terrible",
|
|
"Not sure how I feel"
|
|
])
|
|
print(results)</code></pre>
|
|
<h2>Passing Data</h2>
|
|
<h3>Input Types</h3>
|
|
<p>Accept various input types:</p>
|
|
<pre><code class="lang-python">from typing import List, Dict, Any
|
|
|
|
@app.function()
|
|
def process_primitives(
|
|
count: int,
|
|
ratio: float,
|
|
enabled: bool,
|
|
name: str
|
|
) -> dict:
|
|
return {
|
|
"count": count,
|
|
"ratio": ratio,
|
|
"enabled": enabled,
|
|
"name": name
|
|
}
|
|
|
|
@app.function()
|
|
def process_collections(
|
|
items: List[str],
|
|
config: Dict[str, Any]
|
|
) -> dict:
|
|
return {
|
|
"item_count": len(items),
|
|
"config_keys": list(config.keys())
|
|
}
|
|
|
|
from dataclasses import dataclass
|
|
|
|
@dataclass
|
|
class Task:
|
|
id: int
|
|
title: str
|
|
priority: int
|
|
|
|
@app.function()
|
|
def process_dataclass(task: Task) -> dict:
|
|
return {
|
|
"id": task.id,
|
|
"title": task.title,
|
|
"priority": task.priority
|
|
}</code></pre>
|
|
<h3>Return Values</h3>
|
|
<p>Return serializable data:</p>
|
|
<pre><code class="lang-python">@app.function()
|
|
def return_dict() -> dict:
|
|
return {"status": "success", "count": 42}
|
|
|
|
@app.function()
|
|
def return_list() -> list:
|
|
return [1, 2, 3, 4, 5]
|
|
|
|
@app.function()
|
|
def return_dataclass() -> Task:
|
|
return Task(id=1, title="Example", priority=5)
|
|
|
|
# For large data, use volumes or object storage
|
|
@app.function()
|
|
def process_large_data():
|
|
# Don't return large objects directly
|
|
# Instead, write to volume or upload to S3
|
|
volume.write_file("output.json", json.dumps(large_data))
|
|
return {"location": "output.json"}</code></pre>
|
|
<h2>Error Handling</h2>
|
|
<h3>Retries</h3>
|
|
<p>Configure automatic retries:</p>
|
|
<pre><code class="lang-python">@app.function(retries=3)
|
|
def flaky_api_call():
|
|
"""Retries up to 3 times on failure"""
|
|
import requests
|
|
response = requests.get("https://api.example.com/data")
|
|
response.raise_for_status()
|
|
return response.json()
|
|
|
|
# Custom retry logic
|
|
@app.function()
|
|
def robust_processing(item_id: int):
|
|
import time
|
|
max_attempts = 3
|
|
|
|
for attempt in range(max_attempts):
|
|
try:
|
|
return process_with_external_api(item_id)
|
|
except Exception as e:
|
|
if attempt == max_attempts - 1:
|
|
raise
|
|
print(f"Attempt {attempt + 1} failed: {e}")
|
|
time.sleep(2 ** attempt) # Exponential backoff</code></pre>
|
|
<h3>Exception Handling</h3>
|
|
<p>Handle errors gracefully:</p>
|
|
<pre><code class="lang-python">@app.function()
|
|
def safe_processing(data: dict):
|
|
try:
|
|
result = risky_operation(data)
|
|
return {"status": "success", "result": result}
|
|
except ValueError as e:
|
|
return {"status": "error", "error": str(e)}
|
|
except Exception as e:
|
|
# Log error for debugging
|
|
print(f"Unexpected error: {e}")
|
|
return {"status": "error", "error": "Internal error"}
|
|
|
|
@app.local_entrypoint()
|
|
def main():
|
|
result = safe_processing.remote({"key": "value"})
|
|
if result["status"] == "error":
|
|
print(f"Processing failed: {result['error']}")
|
|
else:
|
|
print(f"Success: {result['result']}")</code></pre>
|
|
<h2>Logging and Debugging</h2>
|
|
<h3>Print Statements</h3>
|
|
<p>Use print for logging (appears in Modal dashboard):</p>
|
|
<pre><code class="lang-python">@app.function()
|
|
def logged_function(item_id: int):
|
|
print(f"Processing item {item_id}")
|
|
|
|
result = process(item_id)
|
|
print(f"Item {item_id} result: {result}")
|
|
|
|
return result</code></pre>
|
|
<h3>Structured Logging</h3>
|
|
<p>Use Python logging module:</p>
|
|
<pre><code class="lang-python">import logging
|
|
|
|
@app.function()
|
|
def structured_logging():
|
|
logger = logging.getLogger(__name__)
|
|
|
|
logger.info("Starting processing")
|
|
logger.warning("This is a warning")
|
|
logger.error("This is an error")
|
|
|
|
return "Done"</code></pre>
|
|
<h2>Testing Functions Locally</h2>
|
|
<h3>Local Testing</h3>
|
|
<p>Test before deploying:</p>
|
|
<pre><code class="lang-python"># test_app.py
|
|
from app import process_item
|
|
|
|
def test_process_item():
|
|
result = process_item.local(42)
|
|
assert result["id"] == 42
|
|
assert result["status"] == "processed"
|
|
|
|
if __name__ == "__main__":
|
|
test_process_item()
|
|
print("Tests passed!")</code></pre>
|
|
<h2>Anti-Patterns to Avoid</h2>
|
|
<p><strong>DON'T use global mutable state without understanding container lifecycle:</strong></p>
|
|
<pre><code class="lang-python"># ❌ BAD - Assumes single invocation
|
|
counter = 0
|
|
|
|
@app.function()
|
|
def bad_counter():
|
|
global counter
|
|
counter += 1
|
|
return counter # Unpredictable across containers
|
|
|
|
# ✅ GOOD - Use parameters or persistent storage
|
|
@app.function()
|
|
def good_counter(current_count: int):
|
|
return current_count + 1</code></pre>
|
|
<p><strong>DON'T return large objects directly:</strong></p>
|
|
<pre><code class="lang-python"># ❌ BAD - Slow and may hit size limits
|
|
@app.function()
|
|
def bad_large_data():
|
|
huge_list = [i for i in range(10_000_000)]
|
|
return huge_list
|
|
|
|
# ✅ GOOD - Use volumes or object storage
|
|
@app.function()
|
|
def good_large_data(volume: modal.Volume):
|
|
huge_list = [i for i in range(10_000_000)]
|
|
volume.write_file("data.json", json.dumps(huge_list))
|
|
return {"location": "data.json", "size": len(huge_list)}</code></pre>
|
|
<p><strong>DON'T use blocking sleep in hot loops:</strong></p>
|
|
<pre><code class="lang-python"># ❌ BAD - Wastes container time
|
|
@app.function()
|
|
def bad_polling():
|
|
while True:
|
|
time.sleep(60)
|
|
check_status()
|
|
|
|
# ✅ GOOD - Use scheduled functions
|
|
@app.function(schedule=modal.Period(minutes=1))
|
|
def good_polling():
|
|
check_status()</code></pre>
|
|
<h2>Related Skills</h2>
|
|
<ul><li><strong>modal-gpu-workloads.md</strong> - GPU configuration for ML workloads</li><li><strong>modal-web-endpoints.md</strong> - Creating HTTP endpoints</li><li><strong>modal-scheduling.md</strong> - Scheduled and periodic functions</li><li><strong>modal-volumes-secrets.md</strong> - Persistent storage and secrets</li><li><strong>modal-image-building.md</strong> - Advanced image configuration</li></ul>
|
|
<footer>
|
|
<div class="fmap">
|
|
<div><b>Build</b>
|
|
<a href="https://hanzo.app">hanzo.app</a> app builder
|
|
<a href="https://hanzo.codes">hanzo.codes</a> code with an agent
|
|
<a href="https://hanzoskills.com">hanzoskills.com</a> what an agent reads</div>
|
|
<div><b>Run</b>
|
|
<a href="https://console.hanzo.ai">console.hanzo.ai</a> cloud console
|
|
<a href="https://api.hanzo.ai">api.hanzo.ai</a> the API</div>
|
|
<div><b>Account</b>
|
|
<a href="https://hanzo.id">hanzo.id</a> sign in
|
|
<a href="https://pay.hanzo.ai">pay.hanzo.ai</a> top up
|
|
<a href="https://billing.hanzo.ai">billing.hanzo.ai</a> invoices and usage</div>
|
|
<div><b>Company</b>
|
|
<a href="https://hanzo.ai">hanzo.ai</a> canonical
|
|
<a href="https://hanzo.ventures">hanzo.ventures</a> ventures</div>
|
|
</div>
|
|
<div class="fend"><a href="/modal-functions-basics.md">This page as plain text</a> · <a href="/llms.txt">Index for agents</a></div>
|
|
</footer>
|
|
</div></body></html> |