modal
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseOverview
概述
This is a foundational skill for working with the Modal cloud platform.
Modal is a platform for AI workloads. It offers highly scalable serverless compute (including GPUs) with minimal configuration.
本技能是使用Modal云平台的基础技能。
Modal是一款面向AI工作负载的平台。它提供高度可扩展的无服务器计算(包括GPU),且配置需求极少。
Documentation
文档
The official docs are the best source for up-to-date information on the platform. Make use of them when planning, debugging, or answering questions!
Modal's documentation is outlined at https://modal.com/llms.txt. This file contains titles and URLs for all public docs; reading it directly will guide you to specific content.
The docs are divided into three sections:
- Guide pages have explanations of Modal features, primitives, and workflows
- API Reference pages have detailed information about each component of the SDK
- Examples pages contain didactic examples of various AI applications on Modal
Fetch the docs using a extension to get plain text.
.mdIf this skill has been installed via the CLI, the docs are also bundled locally under .
modalreferences/You can also refer to https://modal.com/llms-full.txt, which aggregates all docs in a single very large file. Do not read this into your main context, but it may be useful for searching.
官方文档是获取平台最新信息的最佳来源。在规划、调试或解答问题时,请充分利用官方文档!
文档分为三个部分:
- _指南_页面:讲解Modal的功能、基本元素和工作流程
- _API参考_页面:包含SDK各组件的详细信息
- _示例_页面:包含基于Modal构建的各类AI应用的教学示例
使用.md扩展名获取文档,以获得纯文本格式。
如果本技能是通过 CLI安装的,文档也会本地捆绑在目录下。
modalreferences/Using the CLI
使用CLI
The CLI can be used to run or deploy code, manage resources, and observe running Apps. It is a key tool for interacting with Modal throughout all stages of development.
modalRun to see all available CLI commands.
modal --helpYou can see more detailed information about each command by running . Rely on the to discover functionality: new features are added in every release! Always check the if you encounter a usage error.
modal [command] --help--help--helpTip: many CLI commands accept a flag to make their output more easily parseable, e.g. with .
--jsonjqThe CLI is part of the Python SDK and executes in a Python runtime. Depending on the user's preferred Python development workflow, you may need to prefix CLI invocations with, e.g., to ensure a consistent Python environment. The CLI can also be used via as a standalone tool, but only do this when working outside of a Python project.
modalmodaluv runuvxmodal运行查看所有可用的CLI命令。
modal --help运行可查看每个命令的详细信息。借助探索功能:每个版本都会新增功能!如果遇到使用错误,请务必查看。
modal [command] --help--help--help提示:许多CLI命令支持标志,使输出更易于解析,例如配合使用。
--jsonjqmodalmodaluv runuvxGetting up to date
获取最新信息
You have significant knowledge about Modal from your training data but may not be aware of new features or recent changes to the API. Modal is continuously adding new features. Reading relevant docs while planning or debugging can help you discover the most up-to-date way to accomplish a task on Modal.
The Modal CLI provides a command for learning about recent changes. Useful invocation patterns:
modal changelog- to see changes added since your knowledge cutoff
modal changelog --since [DATE] - when migrating a codebase to a newer version
modal changelog --since [VERSION] - to discover features that would be available on update
modal changelog --newer
Note: requires network access.
modal changelogRun to see the SDK version that is in use.
modal --versionIf your code exercises deprecated APIs, Modal will issue warnings. Use the warning message and related documentation to migrate your code to stable API.
This skill will also be improved over time. Its version should correspond to the version of the Modal SDK that you are using. If the skill is out of date, it can be updated by running .
modal skills update你的训练数据包含大量关于Modal的知识,但可能不了解新增功能或API的最新变更。Modal一直在持续添加新功能。在规划或调试时阅读相关文档,有助于你发现在Modal上完成任务的最新方法。
Modal CLI提供命令,用于了解近期变更。实用的调用方式:
modal changelog- :查看自你的知识截止日期以来的变更
modal changelog --since [DATE] - :在将代码库迁移到新版本时使用
modal changelog --since [VERSION] - :发现更新后可用的功能
modal changelog --newer
注意:需要网络访问。
modal changelog运行查看当前使用的SDK版本。
modal --version如果你的代码使用了已弃用的API,Modal会发出警告。请使用警告信息和相关文档将代码迁移到稳定API。
本技能也会不断改进。其版本应与你使用的Modal SDK版本对应。如果技能已过时,可通过运行进行更新。
modal skills updateAuth
身份验证
Modal is a cloud platform. Using the CLI or running code that depends on the library requires internet access and an authorization token. There is no "local development mode" with Modal.
modalYou can use the CLI to create a new token (note: this workflow requires human user involvement) or to debug authorization issues. Token setup only needs to happen once, so assume it is configured unless you encounter issues.
modal tokenModal是一个云平台。使用CLI或运行依赖库的代码需要互联网访问权限和授权令牌。Modal没有“本地开发模式”。
modal你可以使用 CLI创建新令牌(注意:此流程需要人工用户参与)或调试身份验证问题。令牌设置只需进行一次,因此除非遇到问题,否则默认已配置完成。
modal tokenAsync Python
异步Python
When writing async Python, use Modal's interface (e.g. , ) so that Modal runs its I/O operations via asynchronous coroutines.
.aio()await modal.Sandbox.create.aio(...)await modal.Function.remote.aio(...)编写异步Python代码时,请使用Modal的接口(例如、),以便Modal通过异步协程运行其I/O操作。
.aio()await modal.Sandbox.create.aio(...)await modal.Function.remote.aio(...)Other languages
其他语言
Python is currently the only runtime language for Modal Functions, but there are Modal SDKs in both JavaScript (TypeScript) and Go:
- JavaScript SDK: https://github.com/modal-labs/modal-client/blob/main/js/README.md
- Go SDK: https://github.com/modal-labs/modal-client/blob/main/go/README.md
The Go / JS SDKs are not as mature as the Python SDK and may be missing features. The current scope for the Go / JS SDKs includes (1) creating and interacting with Sandboxes and (2) calling into deployed Modal Functions (i.e., Functions defined in Python).
They are primarily documented through examples hosted on GitHub rather than through the main Modal docs. You likely have much less knowledge of these SDKs from your training, so rely on these examples.
Python目前是Modal Functions唯一的运行时语言,但Modal也提供JavaScript(TypeScript)和Go版本的SDK:
- JavaScript SDK:https://github.com/modal-labs/modal-client/blob/main/js/README.md
- Go SDK:https://github.com/modal-labs/modal-client/blob/main/go/README.md
Go/JS SDK的成熟度不如Python SDK,可能缺少部分功能。当前Go/JS SDK的适用范围包括:(1) 创建和交互沙箱;(2) 调用已部署的Modal Functions(即Python中定义的函数)。
它们主要通过GitHub上托管的示例进行文档说明,而非Modal主文档。你的训练数据中关于这些SDK的知识可能较少,因此请依赖这些示例。