Skip to content

update readme #460

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.

Sign up for GitHub

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

Merged
liqul merged 4 commits into from
Feb 8, 2025
Merged

update readme #460

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8f67024
update readme
liqul Jan 26, 2025
d3654f6
Merge branch 'main' into liqun/readme_update
liqul Jan 26, 2025
9d5abf3
Add prompt template management to README
liqul Feb 7, 2025
8a9bda6
fix readme space
liqul Feb 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ Unlike many agent frameworks that only track the chat history with LLMs in text,

## 💥 Highlights

- [x] **Planning for complex tasks** - TaskWeaver, which features task decomposition and progress tracking, is designed to solve complex tasks.
- [x] **Reflective execution** - TaskWeaver supports reflective execution, which allows the agent to reflect on the execution process and make adjustments.
- [x] **Rich data structure** - TaskWeaver allows you to work with rich data structures in Python, such as DataFrames, instead of dealing with strings.
- [x] **Customized algorithms** - TaskWeaver allows you to encapsulate your own algorithms into plugins and orchestrate them.
- [x] **Incorporating domain-specific knowledge** - TaskWeaver is designed to incorporate domain-specific knowledge easily to improve the reliability.
Expand All @@ -54,7 +56,18 @@ Unlike many agent frameworks that only track the chat history with LLMs in text,
- [x] **Easy to use** - TaskWeaver is easy to use with sample plugins, examples and tutorials to help you get started. TaskWeaver offers an open-box experience, allowing users to run it immediately after installation.
- [x] **Easy to debug** - TaskWeaver is easy to debug with detailed and transparent logs to help you understand the entire process, including LLM prompts, the code generation, and execution process.
- [x] **Security consideration** - TaskWeaver supports a basic session management to keep different users' data separate. The code execution is separated into different processes to avoid mutal interference.
- [x] **Easy extension** - TaskWeaver is easy to extend to accomplish more complex tasks with multiple agents as the plugins.
- [x] **Easy extension** - TaskWeaver is easy to extend to accomplish more complex tasks with multiple agents as roles and plugins.

## 📚 Asking for Contributions

There are still many features and improvements can be made. But due to our limited resources, we are not able to implement all of them or the progress will be slow.
We are looking forward to your contributions to make TaskWeaver better.
- [ ] Easy to use and maintainable UX/UI
- [ ] Better plugin experiences, such as displaying updates or stopping in the middle of running the plugin and user confirmation before running the plugin
- [ ] Async interaction with LLMs
- [ ] Support for vision input for Roles such as the Planner and CodeInterpreter
- [ ] Support for remote code execution


## ✨ Quick Start

Expand Down