Skip to content

Commit

Permalink
Update plugin workflow and improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fauzaanu committed Dec 21, 2023
1 parent bbc55e6 commit 7700579
Show file tree
Hide file tree
Showing 3 changed files with 170 additions and 100 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Workflow Plugin for Obsidian

Workflow is an obsidian plugin that allows you to create and run connected LLLM workflows. Each task can be configured to use a different API provider and parameters.
![](.README_images/x.gif)
Workflow is an obsidian plugin that allows you to create and run connected LLM workflows. Each task can be configured to use a different API provider and parameters.

A provider in the context of this plugin is the API connection including the model. Settings such as temperature, frequency penalty and max tokens are defined outside of the provider and are set for each task. This means you can use a provider with different settings.

Expand All @@ -18,10 +18,6 @@ A provider in the context of this plugin is the API connection including the mod
4. each task is focused on a specefic outcome but, the LLM is aware of the final outcome as well (through a system prompt)
5. each task can be configured to use a different provider and parameters

> Here is a 3 step workflow from words, to sentences, to an entire article. Obviousely with more focused steps added in between the results can be improved.
![](.README_images/maldives.gif)

## Parameters for workflow
- `name` : the name of the workflow, just for reference for you, not used anywhere else
- `tasks` : a list of tasks
Expand Down
Loading

0 comments on commit 7700579

Please sign in to comment.