Skip to content

Commit 41b3d16

Browse files
update README.md
1 parent e2a8068 commit 41b3d16

File tree

9 files changed

+66
-9
lines changed

9 files changed

+66
-9
lines changed

β€Ž.DS_Store

-2 KB
Binary file not shown.

β€Ž.idea/.gitignore

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Ž.idea/Nuggt.iml

Lines changed: 14 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Ž.idea/inspectionProfiles/Project_Default.xml

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Ž.idea/inspectionProfiles/profiles_settings.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Ž.idea/misc.xml

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Ž.idea/modules.xml

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Ž.idea/vcs.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€ŽREADME.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
# Nuggt: Automate any task with a single AI command.
22
[![GitHub Repo stars](https://img.shields.io/github/stars/Nuggt-Dev/nuggt?style=social)](https://github.com/Nuggt-Dev/nuggt/)
33

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.
55

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.
77

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 😁.
99

1010
<h2 align="center"> Demo June 8th 2023 </h2>
1111

1212
https://github.com/Nuggt-dev/Nuggt/assets/52075633/f38dffd7-cec0-49a2-b18d-c4759fd0cf5d
1313

1414
## Features
1515

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.
1818
- πŸ”— Build Controlled Bots: Develop controlled autonomous bots capable of automating tasks efficiently.
1919
- 🌐 Tool Integration: Enjoy seamless integration with various tools, including Python, document processing, video analysis, Google search, and web browsing.
2020
- πŸš€ Community-Driven: Participate in a vibrant community, contributing feedback, suggestions, and improvements to shape the project's development.
2121

2222

2323
## 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.
2525

2626
```bash
2727
git clone https://github.com/Nuggt-dev/Nuggt.git
2828
pip install -r requirements.txt
2929
cd nuggt-release
30-
streamlit run Nuggt_Playground.py
30+
streamlit run nuggt.py
3131
```
3232

33-
## Important Docs
34-
* [Documentation](docs/documentation.md)
33+
## Documentation
34+
* [How to use Nuggt](docs/documentation.md)
3535
* [Contribution Guidelines](docs/contribution_guidelines.md)
3636

3737
## Limitations

0 commit comments

Comments
Β (0)