Skip to content

Commit

Permalink
chore: remove older references.
Browse files Browse the repository at this point in the history
  • Loading branch information
codito committed Feb 17, 2024
1 parent b858e95 commit 1d7f22d
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 7 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Please update the `models` section in the config yml to your local model path.
`arey chat`

### 3. Run Arey in play mode

Use to fine-tune a prompt in your editor while `arey` keeps completing your prompt on every save.

```sh
Expand All @@ -84,7 +85,7 @@ Watching `/tmp/arey_playzl9igj3d.md` for changes...
## Development
```sh
# Install myl locally in editable mode.
# Install arey locally in editable mode.
> pip install -e .
> pip install -e .\[test\] # optional, if you wish to run tests
Expand Down
4 changes: 2 additions & 2 deletions docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ We will build upon following concepts.
- Models can support one or both of these modes.
- TODO: more clarification on where and how to use modes.
- **Tasks** are the primary interaction model for this app.
- E.g., `myl <task>` will perform the task.
- E.g., `arey <task>` will perform the task.
- Task is the highest level of abstraction this library will provide.
- Task will own and manage a prompt. E.g., it will understand the prompt
parameters and will fill those at runtime.
Expand Down Expand Up @@ -100,7 +100,7 @@ Let's enumerate few example scenarios to validate the mental model.
- Output: a summary of the provided text.
- Task can support various tweaks like summarize in bullets, or a paragraph.
Optionally, extract keywords etc.
- E.g., `myl summarize --keywords <text blob>` or `cat essay.md | myl summarize`
- E.g., `arey summarize --keywords <text blob>` or `cat essay.md | arey summarize`
- Implementation
- Prompt can use zero shot or few shot mechanism.
- Prompt response can be JSON. We can dynamically provide instruction to
Expand Down
2 changes: 1 addition & 1 deletion docs/samples/classify.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# An example of a prompt to override the model template with custom contexts.
# How to use:
# myl task "Classify the text into one of the categories in JSON format: {\"category\": [\"Technology\", \"Life\", \"Philosophy\"]}. Here's the text:" <path to this file>
# arey task "Classify the text into one of the categories in JSON format: {\"category\": [\"Technology\", \"Life\", \"Philosophy\"]}. Here's the text:" <path to this file>

name: summarize
version: 1
Expand Down
2 changes: 1 addition & 1 deletion docs/samples/classify_file.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import frontmatter
from rich.console import Console

from myl.task import Task, create_task, run
from arey.task import Task, create_task, run

console = Console()

Expand Down
2 changes: 1 addition & 1 deletion docs/samples/summarize.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# An example of a prompt to override the model template with custom contexts.
# How to use:
# myl task "Summarize below text in JSON format: {\"summary\": \"\", \"keywords\": []}. Here's the text: <text>" <path to this file>
# arey task "Summarize below text in JSON format: {\"summary\": \"\", \"keywords\": []}. Here's the text: <text>" <path to this file>

name: summarize
version: 1
Expand Down
2 changes: 1 addition & 1 deletion docs/samples/summarize_file.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
from markdown_it import MarkdownIt
from rich.console import Console

from myl.task import Task, create_task, run
from arey.task import Task, create_task, run

console = Console()

Expand Down

0 comments on commit 1d7f22d

Please sign in to comment.