Skip to content

armgit / txtai

Public Imported from GitHub
0

πŸ’‘ All-in-one AI framework for semantic search, LLM orchestration and language model workflows

Update documentation

davidmezzetti2bdfee9116b3
diff --git a/docs/workflow/schedule.md b/docs/workflow/schedule.md
index 046d7f74..b935faeb 100644
--- a/docs/workflow/schedule.md
+++ b/docs/workflow/schedule.md
@@ -10,11 +10,18 @@ The schedule method takes a cron expression, list of static elements (which dyna
Below are a couple example cron expressions.
```bash
-* * * * * * # Run every second
-0/5 * * * * # Run every 5 minutes
-0 0 1 * * # Run monthly on 1st
-0 0 1 1 * # Run on Jan 1 at 12am
-0 0 * * mon,wed # Run Monday and Wednesday
+# β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ minute (0 - 59)
+# | β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ hour (0 - 23)
+# | | β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ day of the month (1 - 31)
+# | | | β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€ month (1 - 12)
+# | | | | β”Œβ”€β”€β”€β”€β”€β”€β”€ day of the week (0 - 6)
+# | | | | | β”Œβ”€β”€β”€β”€β”€ seconds (0 - 59)
+# | | | | | |
+ * * * * * * # Run every second
+0/5 * * * * # Run every 5 minutes
+ 0 0 1 * * # Run monthly on 1st
+ 0 0 1 1 * # Run on Jan 1 at 12am
+ 0 0 * * mon,wed # Run Monday and Wednesday
```
## Python
@@ -22,7 +29,7 @@ Simple workflow scheduled with Python. See [schedule](../#txtai.workflow.base.Wo
```python
workflow = Workflow(tasks)
-workflow.schedule("0/5 * * * * *", elements)
+workflow.schedule("0/5 * * * *", elements)
```
## Configuration
@@ -32,7 +39,7 @@ Simple workflow scheduled with configuration.
workflow:
index:
schedule:
- cron: 0/5 * * * * *
+ cron: 0/5 * * * *
elements: [...]
tasks: [...]
```
@@ -50,5 +57,5 @@ app.wait()
See the links below for more information on cron expressions.
+- [cron overview](https://en.wikipedia.org/wiki/Cron)
- [croniter - library used by txtai](https://github.com/kiorky/croniter)
-- [cron](https://en.wikipedia.org/wiki/Cron)