Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmezzetti committed Nov 23, 2021
1 parent d782783 commit 01b4ca0
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/workflows/service.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@

Task that runs content against a http service.

```python
workflow = Workflow([ServiceTask(url="https://service.url/action)])
workflow(["parameter"])
```

::: txtai.workflow.ServiceTask.__init__
5 changes: 5 additions & 0 deletions docs/workflows/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,9 @@

Task that expands a local directory or cloud storage bucket into a list of URLs to process.

```python
workflow = Workflow([StorageTask()])
workflow(["s3://path/to/bucket", "local://local/directory"])
```

::: txtai.workflow.StorageTask.__init__
7 changes: 7 additions & 0 deletions docs/workflows/workflow.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
## Workflow Task

Task that runs a Workflow. Allows creating workflows of workflows.

```python
workflow = Workflow([WorkflowTask(workflow)])
workflow(["input data"])
```

::: txtai.workflow.WorkflowTask.__init__

0 comments on commit 01b4ca0

Please sign in to comment.