|
1 | 1 | # Nuggt: Automate any task with a single AI command.
|
2 | 2 | [](https://github.com/Nuggt-Dev/nuggt/)
|
3 | 3 |
|
4 |
| -Nuggt is an open-source project that enables users to create AI agents capable of automating any task. Powered by GPT-3.5 and designed for cost-effectiveness, Nuggt offers a step-by-step prompt format for precise task execution. With seamless integration of tools like Python, document processing, video analysis, Google search, and web browsing, Nuggt empowers users to build controlled autonomous bots efficiently. |
| 4 | +Nuggt is an open-source project that enables users to create AI agents capable of automating any task. Powered by GPT-3.5 and designed for cost-effectiveness, Nuggt offers a step-by-step prompt format for precise task execution. With seamless integration of tools like python, document processing, video analysis, google search, and web browsing, Nuggt empowers users to build controlled autonomous bots efficiently. |
5 | 5 |
|
6 |
| -While our current implementation leverages the power of GPT-3.5, we recognize the need for cost-effective solutions without compromising functionality. Our ongoing efforts involve exploring and harnessing the potential of smaller models like Vicuna 13b, ensuring that task automation remains accessible to a wider audience. |
| 6 | +While our current implementation leverages the power of GPT-3.5, we recognize the need for cost-effective solutions without compromising functionality. Our ongoing efforts involve exploring and harnessing the potential of smaller models like Vicuna 13B, ensuring that task automation remains accessible to a wider audience. |
7 | 7 |
|
8 |
| -Join us on this exciting journey of task automation with Nuggt, as we push the boundaries of what can be achieved with smaller open-source large language models, one step at a time. |
| 8 | +Join us on this exciting journey of task automation with Nuggt, as we push the boundaries of what can be achieved with smaller open-source large language models, one step at a time π. |
9 | 9 |
|
10 | 10 | <h2 align="center"> Demo June 8th 2023 </h2>
|
11 | 11 |
|
12 | 12 | https://github.com/Nuggt-dev/Nuggt/assets/52075633/f38dffd7-cec0-49a2-b18d-c4759fd0cf5d
|
13 | 13 |
|
14 | 14 | ## Features
|
15 | 15 |
|
16 |
| -- ποΈ Create simple functionalities using a single set of instructions. |
17 |
| -- π§ GPT-3.5-turbo instance for cheap, accurate responses powered by prompt engineering. |
| 16 | +- ποΈ All-in-one platform: Create any functionality using a single set of instructions. |
| 17 | +- π§ GPT-3.5-turbo: For cheap, accurate, and fast responses powered by prompt engineering. |
18 | 18 | - π Build Controlled Bots: Develop controlled autonomous bots capable of automating tasks efficiently.
|
19 | 19 | - π Tool Integration: Enjoy seamless integration with various tools, including Python, document processing, video analysis, Google search, and web browsing.
|
20 | 20 | - π Community-Driven: Participate in a vibrant community, contributing feedback, suggestions, and improvements to shape the project's development.
|
21 | 21 |
|
22 | 22 |
|
23 | 23 | ## Quickstart
|
24 |
| -You can setup the API keys either under `.env` file or set it up under settings after launching the app. |
| 24 | +You can setup the API keys either under `.env` file or set it up under settings tab directly on the Nuggt platform. |
25 | 25 |
|
26 | 26 | ```bash
|
27 | 27 | git clone https://github.com/Nuggt-dev/Nuggt.git
|
28 | 28 | pip install -r requirements.txt
|
29 | 29 | cd nuggt-release
|
30 |
| -streamlit run Nuggt_Playground.py |
| 30 | +streamlit run nuggt.py |
31 | 31 | ```
|
32 | 32 |
|
33 |
| -## Important Docs |
34 |
| -* [Documentation](docs/documentation.md) |
| 33 | +## Documentation |
| 34 | +* [How to use Nuggt](docs/documentation.md) |
35 | 35 | * [Contribution Guidelines](docs/contribution_guidelines.md)
|
36 | 36 |
|
37 | 37 | ## Limitations
|
|
0 commit comments