From cc79b46ebacbf763929630a540c58079096eb3bc Mon Sep 17 00:00:00 2001 From: alex Date: Mon, 18 Dec 2023 23:24:10 -0800 Subject: [PATCH] add mockingbird wf overview builder --- .../docs/mockingbird/builder/aggregations.md | 12 ++++++++ .../docs/mockingbird/builder/analysis.md | 14 +++++++++ .../zeusfyi/docs/mockingbird/builder/intro.md | 5 +++- .../docs/mockingbird/builder/retrievals.md | 30 +++++++++++++++++++ .../docs/mockingbird/builder/workflow.md | 10 ++++--- .../zeusfyi/docs/mockingbird/intro.md | 3 ++ .../zeusfyi/docs/mockingbird/runs/intro.md | 13 ++++++-- .../zeusfyi/docs/mockingbird/runs/reports.md | 11 +++++++ 8 files changed, 91 insertions(+), 7 deletions(-) create mode 100644 apps/docusaurus/zeusfyi/docs/mockingbird/builder/aggregations.md create mode 100644 apps/docusaurus/zeusfyi/docs/mockingbird/builder/analysis.md create mode 100644 apps/docusaurus/zeusfyi/docs/mockingbird/builder/retrievals.md create mode 100644 apps/docusaurus/zeusfyi/docs/mockingbird/runs/reports.md diff --git a/apps/docusaurus/zeusfyi/docs/mockingbird/builder/aggregations.md b/apps/docusaurus/zeusfyi/docs/mockingbird/builder/aggregations.md new file mode 100644 index 00000000..679225d0 --- /dev/null +++ b/apps/docusaurus/zeusfyi/docs/mockingbird/builder/aggregations.md @@ -0,0 +1,12 @@ +--- +sidebar_position: 4 +displayed_sidebar: mockingbird +--- + +# Aggregations + +Use this to tell the AI how to aggregate the results of your analysis chunks into a rolling aggregation window. If +aggregating on a single analysis, the aggregation cycle count sets how many base analysis cycles to aggregate on. If +aggregating on multiple analysis, it will aggregate whenever the the underlying analysis is run. + +![gg](https://github.com/zeus-fyi/zeus/assets/17446735/7fa3a1f2-cf92-4442-8b7f-50841dca7f02) diff --git a/apps/docusaurus/zeusfyi/docs/mockingbird/builder/analysis.md b/apps/docusaurus/zeusfyi/docs/mockingbird/builder/analysis.md new file mode 100644 index 00000000..c145bd12 --- /dev/null +++ b/apps/docusaurus/zeusfyi/docs/mockingbird/builder/analysis.md @@ -0,0 +1,14 @@ +--- +sidebar_position: 3 +displayed_sidebar: mockingbird +--- + +# Analysis + +Token overflow strategy will determine how the AI will handle requests that are projected to exceed the maximum token +length for the model you select, or has returned a result with that error. Deduce will chunk your analysis into smaller +pieces and aggregate them into a final analysis result. Truncate will simply truncate the request to the maximum token +length it can support. If you set the max tokens field greater than 0, it becomes the maximum number of tokens to spend +per task request. + +![zzz](https://github.com/zeus-fyi/zeus/assets/17446735/8340c438-5b19-4684-9b19-1cb0c973a5fe) \ No newline at end of file diff --git a/apps/docusaurus/zeusfyi/docs/mockingbird/builder/intro.md b/apps/docusaurus/zeusfyi/docs/mockingbird/builder/intro.md index 68bcc809..0722be09 100644 --- a/apps/docusaurus/zeusfyi/docs/mockingbird/builder/intro.md +++ b/apps/docusaurus/zeusfyi/docs/mockingbird/builder/intro.md @@ -5,4 +5,7 @@ displayed_sidebar: mockingbird # Intro - +The builder section allows you to build tasks (analysis, aggregation), retrievals, evals, and more from the UI and +then mix and match them to quickly create new workflows, which is ideal for rapid prototyping and experimentation. +We tried to keep things as simple as possible to use via the UI to make it as accessible as possible. Let us know if +anything is confusing or you have any questions. diff --git a/apps/docusaurus/zeusfyi/docs/mockingbird/builder/retrievals.md b/apps/docusaurus/zeusfyi/docs/mockingbird/builder/retrievals.md new file mode 100644 index 00000000..8fc6d116 --- /dev/null +++ b/apps/docusaurus/zeusfyi/docs/mockingbird/builder/retrievals.md @@ -0,0 +1,30 @@ +--- +sidebar_position: 5 +displayed_sidebar: mockingbird +--- + +# Retrievals + +For generic retrievals we recommend you setup an API that can be called from the load balancer group for quick starting. + +## Web APIs via Load Balancer + +It will get data from each route in the load balancer group you reference here and then aggregate the results into a +single response. + +![Sc](https://github.com/zeus-fyi/zeus/assets/17446735/6c9f79e8-4ff7-4fc3-bc57-f4d425dbff46) + +The website extraction and keywords feature is still in development, but coming soon you'll be able to use it, but you +can +save instructions for now and it will be available in the future for you to update your retrievals. + +## Discord + +It will get data from each route in the load balancer group you reference here and then aggregate the results into a +single response. + +![Sc](https://github.com/zeus-fyi/zeus/assets/17446735/6c9f79e8-4ff7-4fc3-bc57-f4d425dbff46) + +The website extraction and keywords feature is still in development, but coming soon you'll be able to use it, but you +can +save instructions for now and it will be available in the future for you to update your retrievals. \ No newline at end of file diff --git a/apps/docusaurus/zeusfyi/docs/mockingbird/builder/workflow.md b/apps/docusaurus/zeusfyi/docs/mockingbird/builder/workflow.md index 5a2c863c..d820ee94 100644 --- a/apps/docusaurus/zeusfyi/docs/mockingbird/builder/workflow.md +++ b/apps/docusaurus/zeusfyi/docs/mockingbird/builder/workflow.md @@ -61,14 +61,16 @@ and set the aggregation cycle count to 2, it will run on time cycle 4 after the Think of this as your AI Cpu Time. This is the minimum time interval between AI actions per cycle of workflow execution. So if you have a 5 minute fundamental time period, and you have 3 analysis stages in your workflow per one cycle of run -time, -it will run 3 stages each 5 minutes. +time, it will run 3 stages each 5 minutes. + +## Checkpoints for Stage Driven Workflows + +We're still working on the UI for this, coming soon. ## Run Overrides Using the run scheduler, you can change your fundamental time period, and the run scheduler will automatically adjust -the run times, -this also changes the search window sizes for analysis, aggregation, etc stages. +the run times, this also changes the search window sizes for analysis, aggregation, etc stages. ![AAAA](https://github.com/zeus-fyi/zeus/assets/17446735/bc8099bc-b8b2-4c4a-bbb8-053c4d2f4c22) diff --git a/apps/docusaurus/zeusfyi/docs/mockingbird/intro.md b/apps/docusaurus/zeusfyi/docs/mockingbird/intro.md index 083e9385..05b8665c 100644 --- a/apps/docusaurus/zeusfyi/docs/mockingbird/intro.md +++ b/apps/docusaurus/zeusfyi/docs/mockingbird/intro.md @@ -37,6 +37,7 @@ throttled if you exceed our usage limits while using our API key. - Run Scheduler/Controller - Run Step-by-Step Cycle Execution History - Run Token Usage +- Human-in-the-loop control trigger actions (coming later this week) ## Features Available To Researchers & Partners @@ -50,6 +51,8 @@ throttled if you exceed our usage limits while using our API key. - Experimental distributed executive task planner - Tasking single-to-multi-model task planning - Tasking scheduling, recursive workflows, objective overrides + - Shared workflows contexts, selective contexts, searchable contexts + - Workflow generator - Multi-Model-Single-Model communication via quorums - Multi-Model-Multi-Model communication via quorums + task planning + synchronization - Multi-Modal (Text, Image, Video, Audio) analysis diff --git a/apps/docusaurus/zeusfyi/docs/mockingbird/runs/intro.md b/apps/docusaurus/zeusfyi/docs/mockingbird/runs/intro.md index 65828445..9044f331 100644 --- a/apps/docusaurus/zeusfyi/docs/mockingbird/runs/intro.md +++ b/apps/docusaurus/zeusfyi/docs/mockingbird/runs/intro.md @@ -1,9 +1,18 @@ --- -sidebar_position: 2 +sidebar_position: 1 displayed_sidebar: mockingbird --- -# Intro +# Usage +Press Start to schedule a workflow that will run the analysis on the time intervals you've defined. It will process the +data that gets generated from your search query, and then aggregate the results into over a rolling window. +![zzz](https://github.com/zeus-fyi/zeus/assets/17446735/ee2eb543-e6ee-432d-8ba3-4adb81615956) +## Stopping a Workflow + +You can stop a workflow by pressing the Stop button. It will stop the workflow from running on the next scheduled run +cycle. + +![zzz](https://github.com/zeus-fyi/zeus/assets/17446735/b17515c7-4e6e-406f-b7c2-c9eb0119b4d8) \ No newline at end of file diff --git a/apps/docusaurus/zeusfyi/docs/mockingbird/runs/reports.md b/apps/docusaurus/zeusfyi/docs/mockingbird/runs/reports.md new file mode 100644 index 00000000..39bc0100 --- /dev/null +++ b/apps/docusaurus/zeusfyi/docs/mockingbird/runs/reports.md @@ -0,0 +1,11 @@ +--- +sidebar_position: 2 +displayed_sidebar: mockingbird +--- + +# Reports + +Shows the outputs of each stage within the workflow. You can click on the expand row button to see the details of the +mockingbird run. + +![ddd](https://github.com/zeus-fyi/zeus/assets/17446735/c77d77c4-0023-47f1-8196-66fdd93eeefc)