Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme #727

Merged
merged 7 commits into from
Apr 5, 2024
Merged

Improve readme #727

merged 7 commits into from
Apr 5, 2024

Conversation

collindutter
Copy link
Member

No description provided.

@collindutter collindutter force-pushed the feature/better-readme branch 4 times, most recently from b5ceaff to 2a901d2 Compare April 2, 2024 22:23
README.md Outdated
Comment on lines 16 to 18
- **Agents** 🤖: Consists of a single Task.
- **Pipelines** 🔄: Organizes a sequence of Tasks so that the output from one Task may flow into the next.
- **Workflows** 🌐: Configures Tasks to operate in parallel.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should reword these to read more naturally given the plural structure names:

Agents: Consist of a single Task.

README.md Outdated

### Memory 🧠

- **Conversation** 💬: Enables LLMs to retain and retrieve information across interactions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we move the emoji to the left, we could work these into full sentences:

💬 Conversation Memory enables LLMs to retain and retrieve information across interactions.

@collindutter collindutter force-pushed the feature/better-readme branch 2 times, most recently from bb66498 to 61fc26a Compare April 4, 2024 23:34
@collindutter collindutter force-pushed the feature/better-readme branch 3 times, most recently from 666a6e8 to 62827c6 Compare April 5, 2024 20:54
SavagePencil
SavagePencil previously approved these changes Apr 5, 2024
@collindutter collindutter marked this pull request as ready for review April 5, 2024 20:59
README.md Show resolved Hide resolved
@collindutter collindutter merged commit ef764c9 into dev Apr 5, 2024
6 checks passed
@collindutter collindutter deleted the feature/better-readme branch April 5, 2024 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants