Skip to content

Commit

Permalink
liqun/update_readme (microsoft#97)
Browse files Browse the repository at this point in the history
update readme for demo videos and corresponding text changes
  • Loading branch information
ShilinHe authored Jan 2, 2024
2 parents bbbeaa6 + 33a4e13 commit 129a46a
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ coordinates a variety of plugins in the form of functions to execute
data analytics tasks.

# News🆕
- 📅2024-01-01: Happy New Year 🎆 with TaskWeaver [Discord](https://discord.gg/Z56MXmZgMb).
- 📅2023-12-21: TaskWeaver now supports a number of LLMs, such as LiteLLM, Ollama, Gemini, and QWen🎈.
- 📅2023-12-21: TaskWeaver Website is now [available](https://microsoft.github.io/TaskWeaver/) with more documentations.
- 📅2023-12-12: A simple UI demo is available in playground/UI folder, try it [here](https://microsoft.github.io/TaskWeaver/docs/usage/webui)!
Expand Down Expand Up @@ -89,18 +90,18 @@ More documentations can be found on [TaskWeaver Website](https://microsoft.githu



---
---


## Demo Examples


The demos were made based on the [web UI](https://microsoft.github.io/TaskWeaver/docs/usage/webui), which is better for displaying the generated artifacts such as images.
The demos could also be conducted in the command line interface.

#### Example 1: Pull data from a database and apply an anomaly detection algorithm
In this example, we will show you how to use TaskWeaver to pull data from a database and apply an anomaly detection algorithm.

[Anomaly Detection](https://github.com/microsoft/TaskWeaver/assets/7489260/9f854acf-f2bf-4566-9d16-f84e915d0f4e)
[Anomaly Detection](https://github.com/microsoft/TaskWeaver/assets/7489260/248b9a0c-d504-4708-8c2e-e004689ee8c6)

If you want to follow this example, you need to configure the `sql_pull_data` plugin in the `project/plugins/sql_pull_data.yaml` file.
You need to provide the following information:
Expand All @@ -121,10 +122,10 @@ pip install langchain
pip install tabulate
```

#### Example 2: Forecast QQQ's price in the next week
In this example, we will show you how to use TaskWeaver to forecast QQQ's price in the next week using the ARIMA algorithm.
#### Example 2: Forecast QQQ's price in the next 7 days
In this example, we will show you how to use TaskWeaver to forecast QQQ's price in the next 7 days.

[Nasdaq 100 Index Price Forecasting](https://github.com/microsoft/TaskWeaver/assets/7489260/c2b09615-52d8-491f-bbbf-e86ba282e59a)
[Nasdaq 100 Index Price Forecasting](https://github.com/microsoft/TaskWeaver/assets/7489260/1361ed83-16c3-4056-98fc-e0496ecab015)

If you want to follow this example, you need to you have two requirements installed:
```bash
Expand All @@ -135,7 +136,8 @@ pip install statsmodels
For more examples, please refer to our [paper](http://export.arxiv.org/abs/2311.17541).

> 💡 The planning of TaskWeaver are based on the LLM model. Therefore, if you want to repeat the examples, the execution process may be different
> from what you see in the videos. Typically, more concrete prompts will help the model to generate better plans and code.
> from what you see in the videos. For example, in the second demo, the assistant may ask the user which prediction algorithm should be used.
> Typically, more concrete prompts will help the model to generate better plans and code.


## Citation
Expand Down

0 comments on commit 129a46a

Please sign in to comment.