Skip to content

Commit e9a0984

Browse files
docs(api-reference): regenerate API docs (automated) (#1580)
Signed-off-by: unionai-docsy-bot[bot] <295918299+unionai-docsy-bot[bot]@users.noreply.github.com> Co-authored-by: unionai-docsy-bot[bot] <295918299+unionai-docsy-bot[bot]@users.noreply.github.com>
1 parent eadbd66 commit e9a0984

327 files changed

Lines changed: 463 additions & 353 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/api-reference/flyte-cli.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Flyte CLI"
3-
version: 2.7.0
3+
version: 2.7.1
44
variants: +flyte +union
55
layout: py_api
66
weight: 3
@@ -660,11 +660,16 @@ Example:
660660
$ flyte create trigger my_task my_trigger --schedule "0 0 * * *"
661661
```
662662

663-
This will create a trigger that runs every day at midnight.
663+
This will create a trigger that runs every day at midnight. Omit `--schedule` to create a
664+
trigger with no automation, which is only fired on demand:
665+
666+
```bash
667+
$ flyte create trigger my_task my_trigger
668+
```
664669

665670
| Option | Type | Default | Description |
666671
|--------|------|---------|-------------|
667-
| `--schedule` | `text` | `Sentinel.UNSET` | Cron schedule for the trigger. Defaults to every minute. |
672+
| `--schedule` | `text` | | Cron schedule for the trigger. If omitted, the trigger has no automation and is only fired on demand. |
668673
| `--description` | `text` | `` | Description of the trigger. |
669674
| `--auto-activate` | `boolean` | `True` | Whether the trigger should not be automatically activated. Defaults to True. |
670675
| `--trigger-time-var` | `text` | `trigger_time` | Variable name for the trigger time in the task inputs. Defaults to `trigger_time`. |

content/api-reference/flyte-sdk/_index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Flyte SDK
33
description: "Flyte SDK for authoring compound AI applications, services and workflows."
44
icon: book
5-
version: 2.7.0
5+
version: 2.7.1
66
variants: +flyte +union
77
layout: py_api
88
weight: 4
@@ -43,7 +43,7 @@ Flyte is the core Python SDK for the Union and Flyte platforms.
4343
| [`flyte.TaskEnvironment`](flyte/taskenvironment) | Define an execution environment for a set of tasks. |
4444
| [`flyte.TaskTemplate`](flyte/tasktemplate) | Task template is a template for a task that can be executed. |
4545
| [`flyte.Timeout`](flyte/timeout) | Timeout bounds for a task. |
46-
| [`flyte.Trigger`](flyte/trigger) | Specification for a scheduled trigger that can be associated with any Flyte task. |
46+
| [`flyte.Trigger`](flyte/trigger) | Specification for a trigger that can be associated with any Flyte task. |
4747
| [`flyte.ai.agents.AccessDenied`](flyte.ai.agents/accessdenied) | Raised when a write targets a read-only or reserved prefix. |
4848
| [`flyte.ai.agents.Agent`](flyte.ai.agents/agent) | A flyte-native tool-use agent harness. |
4949
| [`flyte.ai.agents.AgentEvent`](flyte.ai.agents/agentevent) | Lightweight event emitted by the agent loop. |
@@ -205,6 +205,7 @@ Flyte is the core Python SDK for the Union and Flyte platforms.
205205
| [`flyte.remote.TaskDetails`](flyte.remote/taskdetails) | |
206206
| [`flyte.remote.TimeFilter`](flyte.remote/timefilter) | Filter for time-based fields (e.g. created_at, updated_at). |
207207
| [`flyte.remote.Trigger`](flyte.remote/trigger) | Represents a trigger in the Flyte platform. |
208+
| [`flyte.remote.TriggerDetails`](flyte.remote/triggerdetails) | |
208209
| [`flyte.remote.User`](flyte.remote/user) | Represents a user in the Flyte platform. |
209210
| [`flyte.report.Report`](flyte.report/report) | |
210211
| [`flyte.report.Timeline`](flyte.report/timeline) | Append a best-effort chronological timeline to a tab of the task report. |
@@ -269,7 +270,7 @@ Flyte is the core Python SDK for the Union and Flyte platforms.
269270
| [`flyte.map()`](flyte/_index#map) | Map a function over the provided arguments with concurrent execution. |
270271
| [`flyte.new_condition()`](flyte/_index#new_condition) | Create a condition that can be awaited in a workflow. |
271272
| [`flyte.rerun()`](flyte/_index#rerun) | Re-run a prior run, returning a new `Run`. |
272-
| [`flyte.run()`](flyte/_index#run) | Run a task with the given parameters. |
273+
| [`flyte.run()`](flyte/_index#run) | Run a task with the given parameters, or fire a deployed trigger on demand. |
273274
| [`flyte.run_python_script()`](flyte/_index#run_python_script) | Package and run a Python script on a remote Flyte cluster. |
274275
| [`flyte.serve()`](flyte/_index#serve) | Serve a Flyte app using an AppEnvironment. |
275276
| [`flyte.trace()`](flyte/_index#trace) | A decorator that traces function execution with timing information. |

content/api-reference/flyte-sdk/flyte.ai.agents.agent/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: flyte.ai.agents.agent
33
description: "Agent — a flyte-native tool-use agent harness."
44
icon: box-seam
5-
version: 2.7.0
5+
version: 2.7.1
66
variants: +flyte +union
77
layout: py_api
88
---

content/api-reference/flyte-sdk/flyte.ai.agents.agent/agent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Agent
33
description: "A flyte-native tool-use agent harness."
44
icon: braces
5-
version: 2.7.0
5+
version: 2.7.1
66
variants: +flyte +union
77
layout: py_api
88
---

content/api-reference/flyte-sdk/flyte.ai.agents.agent/agentevent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: AgentEvent
33
description: "Lightweight event emitted by the agent loop."
44
icon: braces
5-
version: 2.7.0
5+
version: 2.7.1
66
variants: +flyte +union
77
layout: py_api
88
---

content/api-reference/flyte-sdk/flyte.ai.agents.memory/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: flyte.ai.agents.memory
33
description: "Dir-backed memory for `flyte.ai.agents.Agent`."
44
icon: box-seam
5-
version: 2.7.0
5+
version: 2.7.1
66
variants: +flyte +union
77
layout: py_api
88
---

content/api-reference/flyte-sdk/flyte.ai.agents.memory/accessdenied.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: AccessDenied
33
description: "Raised when a write targets a read-only or reserved prefix."
44
icon: exclamation-triangle
5-
version: 2.7.0
5+
version: 2.7.1
66
variants: +flyte +union
77
layout: py_api
88
---

content/api-reference/flyte-sdk/flyte.ai.agents.memory/concurrencyerror.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ConcurrencyError
33
description: "Raised when an `expected_sha` precondition does not match the current state."
44
icon: exclamation-triangle
5-
version: 2.7.0
5+
version: 2.7.1
66
variants: +flyte +union
77
layout: py_api
88
---

content/api-reference/flyte-sdk/flyte.ai.agents.memory/memorymeta.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: MemoryMeta
33
description: "Per-file metadata sidecar (sha256, actor, timestamp, …) for a memory entry."
44
icon: braces
5-
version: 2.7.0
5+
version: 2.7.1
66
variants: +flyte +union
77
layout: py_api
88
---

content/api-reference/flyte-sdk/flyte.ai.agents.memory/memorystore.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: MemoryStore
33
description: "Conversation transcript + path-addressed artifact memory backed by `flyte.io.Dir`."
44
icon: braces
5-
version: 2.7.0
5+
version: 2.7.1
66
variants: +flyte +union
77
layout: py_api
88
---

0 commit comments

Comments
 (0)