Skip to content

Commit

Permalink
update the docs with tools 3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
shlomsh committed Aug 14, 2023
1 parent 4f8223f commit 81376d5
Show file tree
Hide file tree
Showing 6 changed files with 51 additions and 30 deletions.
7 changes: 0 additions & 7 deletions docs/add-new-tool.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
# Growing GeniA's Toolbox

<p align=center>
<a href="https://genia.dev" target="_blank">
<img src="../media/tools_3.png"/>
</a>
</p>
<br>

## Teaching GeniA new Skills: Adding Tools Effortlessly

Adding a new tool adheres to the [OpenAI JSON configuration](https://platform.openai.com/docs/api-reference/chat/create#chat/create-functions) standards. This ensures compatibility, making it easy to import any existing function-calling project or ChatGPT plugin.
Expand Down
10 changes: 6 additions & 4 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting started

The easiest way to get started with GeniA is [Streamlit](https://streamlit.io/) web app. Make sure you have `python3` & `pip3` installed, then run:
The easiest way to get started with GeniA is using [Streamlit](https://streamlit.io/) web app. Make sure you have `python3` & `pip3` installed, then run:

```
pip3 install streamlit genia
Expand All @@ -12,12 +12,14 @@ Then you can run the streamlit web app by:
genia
```

You can also play with GeniA in a Terminal using GeniA 'local' mode, both provide a sneak peek, but GeniA is crafted for team collaboration and works best in Slack. For simplicity, we recommend running it locally using [Docker](#run-via-docker). If you want to run docker locally, please refer to the [Installation](#installation) section.
You can also play with GeniA in a Terminal using GeniA 'local' mode.

### Open AI Azure deployment
Both quick start options provide a sneak peek, but **GeniA is crafted for team collaboration** and works best in **Slack**.

When using Azure OpenAI, add those to your environment variables:
For simplicity, we recommend running it locally using [Docker](#run-via-docker). If you want to run docker locally, please refer to the [Installation](#installation) section.

### Open AI Azure deployment
When using Azure OpenAI, add those to your environment variables:
```
OPENAI_API_DEPLOYMENT=
OPENAI_API_TYPE="azure"
Expand Down
39 changes: 24 additions & 15 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,6 @@
# Introduction

## Introducing Tools 3.0: Enhance Coding with Large Language Models

Tools 2.0 with low-code/no-code approaches have been revolutionary, allowing users to leverage drag-and-drop functions over traditional coding for certain use cases.

However, with the advent of Language Learning Models (LLMs), Tools 3.0 pushes the boundary further, empowering everyone to write code using natural language. It signifies a shift from proprietary, restrictive design paradigms to a more open, innovative approach where the model assists in understanding and revising complex code snippets.

Tools 3.0 negates the need for proprietary YAML files and vendor-specific domain languages (DSLs), urging users to rely on native code. Rather than waiting for vendor updates to fulfill requirements, users can now instruct LLMs to write code, create it themselves, or utilize the vast range of community-contributed tools.

Remember, any class, method, or API available becomes a learning and application tool for GeniA. Tools 3.0 redefines coding, transforming it into an intuitive, flexible, and democratized process.

## Features
### Features

GeniA's unique features include:

Expand All @@ -20,18 +10,37 @@ GeniA's unique features include:
4. **Customizable and Extensible**: As an open-source tool, GeniA can be tailored to your specific needs.
5. **Quick Learner**: Rapidly adapts to new tools and APIs.

## Comparison to LLM
### How is GeniA different from ChatGPT?

**Safety Prioritized:** While LLMs offer suggestions, GeniA goes a step further but with utmost caution. It's designed to function responsibly in live environments, ensuring it doesn't take unrestricted decisions.

**Beyond Recommendations:** Where LLMs provide guidance, GeniA offers proactive assistance. It doesn't just advise on the steps you need to take but goes ahead to perform the tasks itself. You could provide a code snippet, and GeniA will handle its deployment to Lambda, integrating seamlessly with your production environment and CI/CD tools.

**Intelligent Tool Selection:** GeniA is not just another tool, it's also a tool-finding system. It's designed to acquaint itself with an expansive set of tools. However, mindful of the limitations of the LLM context window and token costs, it optimizes and feeds the model with only the most relevant tools. Utilizing vector databases (FAISS by default), GeniA selects tools with descriptions that align best with your intent. This smart selection process allows GeniA to work more efficiently and be more responsive to your specific needs.

## Can GeniA Interface with Any Existing API?
**GeniA can easily learn new tools:**
we have worked hard to prioritize the simplicity of adding a new tool to GeniA, [read more about it here](add-new-tool.md).

### Can GeniA Interface with Any Existing API?

Indeed, GeniA has the capability to connect with any available API. Although it's currently an active area of academic research rather than a full-fledged production-grade tool, we've adapted OpenAI's plugin approach for increased simplicity and wider integration possibilities. You can incorporate GeniA into any existing code classes or APIs.
Yes! GeniA has the capability to connect with any available API. Although it's currently an active area of academic research rather than a full-fledged production-grade tool, we've adapted OpenAI's plugin approach for increased simplicity and wider integration possibilities. You can incorporate GeniA into any existing code classes or APIs.

Our ultimate achievement is empowering GeniA to acquire new skills without necessitating model fine-tuning or, in many cases, redeployment of your service. However, it's worth noting that the introduction of a completely new tool might call for some prompt adjustments and testing.

Presently, the authentication process for a new tool falls on the tool creator. However, we plan to standardize this aspect within the project framework shortly.
Presently, the authentication process for a new tool falls on the tool creator. However, we plan to standardize this aspect within the project framework shortly.

### Introducing Tools 3.0: Enhance Coding with Large Language Models

Tools 2.0 with low-code/no-code approaches have been revolutionary, allowing users to leverage drag-and-drop functions over traditional coding for certain use cases.

However, with the advent of Language Learning Models (LLMs), Tools 3.0 pushes the boundary further, empowering everyone to write code using natural language. It signifies a shift from proprietary, restrictive design paradigms to a more open, innovative approach where the model assists in understanding and revising complex code snippets.

Tools 3.0 negates the need for proprietary YAML files and vendor-specific domain languages (DSLs), urging users to rely on native code. Rather than waiting for vendor updates to fulfill requirements, users can now instruct LLMs to write code, create it themselves, or utilize the vast range of community-contributed tools.

Remember, any class, method, or API available becomes a learning and application tool for GeniA. Tools 3.0 redefines coding, transforming it into an intuitive, flexible, and democratized process.

<p align=center>
<a href="https://genia.dev" target="_blank">
<img src="../media/tools_3.png"/>
</a>
</p>
3 changes: 1 addition & 2 deletions docs/supported-tools.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
## Supported Tools

This is where the power of the community comes in! we need your help and support teaching GeniA more tools and best practices. adding more tools is super easy and fun!
<p align="center">
<br/>
<br/>
<img src="../media/genia_diagram.png"/>
<br/>
Expand Down
17 changes: 17 additions & 0 deletions docs/tools3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# We introduce Tools 3.0

### Enhanced Coding with Large Language Models

Up until now, using Tools 2.0 with low-code/no-code approaches have been revolutionary, allowing users to leverage drag-and-drop functions over traditional coding for certain use cases.

However, with the advent of Language Learning Models (LLMs), Tools 3.0 pushes the boundary further, empowering everyone to write code using natural language. It signifies a shift from proprietary, restrictive design paradigms to a more open, innovative approach where the model assists in understanding and revising complex code snippets.

Tools 3.0 negates the need for proprietary YAML files and vendor-specific domain languages (DSLs), urging users to rely on native code. Rather than waiting for vendor updates to fulfill requirements, users can now instruct LLMs to write code, create it themselves, or utilize the vast range of community-contributed tools.

Remember, any class, method, or API available becomes a learning and application tool for GeniA. Tools 3.0 redefines coding, transforming it into an intuitive, flexible, and democratized process.

<p align=center>
<a href="https://genia.dev" target="_blank">
<img src="../media/tools_3.png"/>
</a>
</p>
5 changes: 3 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,11 @@ markdown_extensions:
# Page tree
nav:
- Home: index.md
- Getting started:
- Installation: getting-started.md
- Documentations:
- Introduction: introduction.md
- Getting started: getting-started.md
- Supported Tools: supported-tools.md
- Tools 3.0: tools3.md
- Security: security.md
- Contributing:
- contributing/index.md
Expand Down

0 comments on commit 81376d5

Please sign in to comment.