Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Method lock (recipe.lock.json) status and upgrades
tp recipe status <EXP> # Single experiment: field-level diff between the lock and the current catalog
tp recipe status --all # Scan all of experiments / smoke
tp recipe status <EXP> --server # Also handshake against the catalog published by the Console
tp recipe upgrade <EXP> # Upgrade the lock (framework version unchanged)
tp recipe upgrade <EXP> --framework-version 0.9.0 # Also switch the framework version
tp recipe upgrade --all # Validate everything first, then write uniformly
tp recipe upgrade <EXP> --dry-run # Only show the diff, do not write files
| Option | Description |
|---|---|
--all | Upgrade all experiments in the repository uniformly (validate first, then write) |
--dry-run | Only show the diff |
--framework-version | Switch the framework version while upgrading |
--accept-runtime-change | Explicit confirmation when the upgrade involves a runtime (image) change |
recipe.lock.json — remember to commit, or your next submission will be blocked by a dirty working tree. In submission scenarios you can do it in one step with tp submit --upgrade-recipe.tp recipetp recipe <subcommand>
| Command | Description |
|---|---|
tp recipe ls | List every available method |
tp recipe status | Show an experiment’s lock drift |
tp recipe sync | Sync published methods to this machine |
tp recipe upgrade | Upgrade an experiment lock |
tp recipe lstp recipe ls [options]
| Option | Description |
|---|---|
--source | Only one source: builtin | user |
tp recipe statustp recipe status [EXP] [options]
| Argument | Description |
|---|---|
EXP | Experiment name or path; omitting it requires —all |
| Option | Description |
|---|---|
--all | Scan experiments/ and smoke/ |
--server | Also cross-check against the Console catalog |
tp recipe synctp recipe sync [options]
| Option | Description |
|---|---|
--server | Console address (defaults to the one you logged into) |
--prune | Whether to drop methods that exist locally but not on the platform (or were unpublished) |
tp recipe upgradetp recipe upgrade [EXP] [options]
| Argument | Description |
|---|---|
EXP | Experiment name or path; mutually exclusive with —all |
| Option | Description |
|---|---|
--all | Validate everything first, then write in one go |
--dry-run | Only show the diff, write nothing |
--framework-version | Also move to this exact framework version |
--accept-runtime-change | When the locked framework version is gone from the catalog, fall back to the current default |