Skip to content

Commit

Permalink
Release v0.2.0 (#60)
Browse files Browse the repository at this point in the history 
* Release v0.2.0

* Readme update
  • Loading branch information
@wwwwww1020
wwwwww1020 authored Oct 4, 2023
1 parent 50f1b4f commit 5e0d19f
Show file tree
Hide file tree
Showing 49 changed files with 817 additions and 324 deletions.
152 changes: 43 additions & 109 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,32 +1,23 @@
![IMG_4502](https://github.com/AI-Citizen/SolidGPT/assets/39673228/347a6be2-93d6-42e9-99e2-f8b7b1ea96de)
<h1 align="center">🧱 SolidGPT-Human-AI collaboration framework</h1>
<h1 align="center">🧱 SolidGPT-Technology Business Boosting Framework</h1>

<a href="docs/Introduction_CN.md"><img src="https://img.shields.io/badge/文档-中文版-blue.svg" alt="CN doc"></a>
[![Twitter Follow](https://img.shields.io/twitter/follow/SolidGPT?style=social)](https://twitter.com/SolidGPT)

# 🚀 What’s this
**V0.2.0:** Help you generate Product Requirement Document and Code Solution base on your private project with one line command.

SolidGPT is a human-AI collaboration framework. Users can add private data and create their own agent workgraph using embedding finetuning and in-context learning simply with our framework. Our goal: empower AI to work with humans using tools to accomplish business tasks.

Currently, our framework are optimized for software development using tools Notion, Lowdefy. From the inception of an idea to the documentation of software development, task division, and eventual task implementation - everything can either be automatically or semi-automatically accomplished within SolidGPT.

# 📺 Demo

https://github.com/AI-Citizen/SolidGPT/assets/39673228/3c547894-c34b-4117-b895-dfa55f3afe1e

(The video's playback speed has been accelerated)
>SolidGPT is a human-AI collaboration framework. Users can add private data and create their own agent workgraph using embedding finetuning and in-context learning simply with our framework. Our goal: empower AI to work with humans using tools to accomplish business tasks.
# 🏁 Quick Start

## **Prerequisite**
## 🧱 **Prerequisite**

- python3.8 or above
- (Optional)[Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable) - Required if you wish to utilize the SolidPortal
- [pnpm](https://pnpm.io/installation) - Install pnpm and making activating Corepack `corepack enable`. This is required for Lowdefy webapp to run.
- [Openai api key](https://openai.com/blog/openai-api)
- (Optional）[Notion](https://developers.notion.com/) - Create Notion api key and get the Notion page id which you want to use as the output AI content.

## **Quick Setup**
## 🔧 **Setup**
```sh
git clone https://github.com/AI-Citizen/SolidGPT.git
cd SolidGPT
Expand All @@ -38,114 +29,57 @@ pip3 install -r requirements.txt #installing the env

- (optional)input your notion token and page id
- Set project root folder as python path
Linux/Mac
```sh
export PYTHONPATH=$PYTHONPATH:$(git rev-parse --show-toplevel)/
```
Windows
Run in cmd
```cmd
for /f %%i in ('git rev-parse --show-toplevel') do set PYTHONPATH=%PYTHONPATH%;%%i\
```
or setup manually


## **Run Demo**
**Acutal real start up project "AI Says" - stock analysis app dev workflow**
include the brainstorming, write product requirement, write high level design, create kanban.
```sh
cd quickstart
python3 creategraph.py system
python3 quickstart.py system
```

**webapp dev workflow**
-include the brainstorming, write product requirement, write high level design, create kanban, generate app code(beta test), run web app.
```sh
cd quickstart
python3 creategraph.py webapp
python3 quickstart.py webapp
```
>The default initial iutput path is set to `SolidGPT/localstorage/workspace/in`. As part of the Demo, we have included two idea inputs in this location.
>The default output path is set to `SolidGPT/localstorage/workspace/out/<time - e.g. 202009011234>`
## **Start Your Own Graph**
0. (Optional) Customize your own agent and skill [(Learn more)](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/customagentskill.md)
1. Create a graph using Solid Portal. [(Learn more)](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/solidportal.md).
You can also create a graph json file by code. Please check `quickstart/creategraph.py`
1. Add your initial business idea into the input folder e.g. `SolidGPT/localstorage/workspace/in/your_initial_input_file.json`. Make sure the initial input folder path same with the graph first node input.param_path.
1. Create an entry point located in the solidgpt folder and input the workgraph json file path
```python
# your_file_name.py
from solidgpt.src.orchestration.orchestration import *
Initializer()
app = Orchestration()
app.add_graph("your/graph/config_file.json", "default graph")
app.run_graph_with_name("default graph")
```
You can check the `quickstart/quickstart.py` as example.
3. Run the code with python3 your_file_name.py


## ⁉️ What can this help with?

- Speed up the journey from idea to functioning app.
- Agents that are semi/fully automated run the specific business tasks with private data.
- Engage with QA/chatbots enhanced by private data.

# 🔥 Key Features

## Boost Software Product

Processes can be either fully or semi-automated with users interfacing through Notion. Agents ensure efficiency and quality in every step.

Three key agents are:

- **PM Agent**: Refines ideas into structured PRD documents. Users can collaborate and tweak outputs on Notion for maximum value.
- **PE Agent**: Creates high-level designs, splits them into tasks, and organizes them on a Notion Kanban board. Tasks are distributed between AI and human teams.
- **SDE Agent**: Train the Agent to harness the open-source project, Lowdefy. This approach highlights the value of smart tool integration.
- Linux/Mac
```sh
export PYTHONPATH=$PYTHONPATH:$(git rev-parse --show-toplevel)/
```
- Windows

![sopdiagram](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/images/sopdiagram.png)
Replace path\to\directory with the path of the project root directory
```cmd
set PYTHONPATH=path\to\directory
```

## 🤖 Deep Customized Agent Skill

### Connect private dataset
## 🔥 **Run**

easier use private data to make a QA bot or add LLM prompt to do in-context-learning.

provide the embedding and query the private data easily.
**Generate Technical Solution** - deeply integrate with your private project code to resolve your problem

### Auto Alignment

Using few-shot learning and auto-generating principles based on user tasks can allow AI to always follow principles, resulting in a more stable and reliable LLM.

### Dynamic Agent Skill

Automatically generate the customized agent skills base on the key word. And make up user’s business agents team

## 🕸️ Solid Graph

### Customized workflow

People can build a agents graph, each agent will focus on the specific work and pass the work result to the user and other agents. User can review/edit/regenerate the agent output.

![solidportal](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/images/solidportalscreenshot.png)

### Visualized Build Graph UI
```sh
cd quickstart
python3 start_solution.py -r "your requiremennt" -c "/your/code/file/path"
```

We also provide the UI let user build the solid Graph easier and quicker.

## 🏉 Human-AI Deep Collaboration
**Generate PRD** - deeply integrate with your private project inforamtion to generate the Product Requirement Document

### Collaborate with AI
***Default ouput path is SolidGPT/quickstart***

Agent-created content auto-syncs with Notion, enabling user reviews during the LLM workflow. Subsequent agents use the user-edited result. Users can also establish a fully automated agent workflow.
```sh
cd quickstart
python3 start_prd.py -r "your requiremennt" -a <your project background>(optional) -b </your/project/wiki/file/path>(optional)
```
### Samples
***Generate Technical Solutions Sample***
```sh
### Notion
python3 start_solution.py -r "Help me integrate donate api with paypal api" -c /your/relateived/code/file/path
```
***Generate PRD Samples***
```sh
Notion, powered by LLM, can assist users with quickly editing, improving, reviewing, sharing, and sending final content editions to the next LLM agent.
# No private data writing PRD
python3 start_prd.py -r "Help me write a blog plateform prd"
# Adding Private data into the consideration
python3 start_prd.py -r "Adding donate feature to my blog" -b /my/project/wiki/file/path.md
python3 start_prd.py -r "Adding donate feature to my blog" -a "I am pleased to introduce our specialized U.S. stock blogging platform. This platform not only enables users to register and submit insightful articles but also allows readers to comment, share their trading perspectives, and keep abreast of breaking financial news. It has been thoughtfully designed to cultivate a robust exchange of ideas and information amongst financial enthusiasts."
python3 start_prd.py -r "Adding donate feature to my blog" -b /my/project/wiki/file/path.md -a "I am pleased to introduce our specialized U.S. stock blogging platform. This platform not only enables users to register and submit insightful articles but also allows readers to comment, share their trading perspectives, and keep abreast of breaking financial news. It has been thoughtfully designed to cultivate a robust exchange of ideas and information amongst financial enthusiasts."
```

## 🖇️ Document
[Explore SolidGPT](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/READMEv1.md)

[Solid Portal](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/solidportal.md)

[Solid GPT Infrastructure](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/infrastructure.md)
Expand All @@ -162,4 +96,4 @@ Notion, powered by LLM, can assist users with quickly editing, improving, review
If you have any questions or feedback about our project, please don't hesitate to reach out to us. We greatly appreciate your suggestions!
- Email: aict@ai-citi.com
- GitHub Issues: For more technical inquiries, you can also create a new issue in our [GitHub repository](https://github.com/AI-Citizen/SolidGPT/issues).
We will respond to all questions within 2-3 business days.
We will respond to all questions within 2-3 business days.
94 changes: 94 additions & 0 deletions docs/Introduction_CN_v2.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
![IMG_4502](https://github.com/AI-Citizen/SolidGPT/assets/39673228/347a6be2-93d6-42e9-99e2-f8b7b1ea96de)
<h1 align="center">🧱 SolidGPT-技术业务推进框架</h1>

[![Twitter Follow](https://img.shields.io/twitter/follow/SolidGPT?style=social)](https://twitter.com/SolidGPT)

# 🚀 欢迎使用SolidGPT
**V0.2.0:** 用一行命令帮助您生成产品需求文档和基于您的私人项目的代码解决方案。

>SolidGPT 是一个人工智能合作框架。用户可以添加私有数据并使用我们的框架简单地通过嵌入式微调和上下文学习创建自己的代理工作图。我们的目标：使用工具赋予AI与人类合作完成业务任务的能力。
# 🏁 快速开始

## 🧱 **前提条件**

- python3.8 或以上版本
- [Openai api key](https://openai.com/blog/openai-api)

## 🔧 **设置**
```sh
git clone https://github.com/AI-Citizen/SolidGPT.git
cd SolidGPT
pip3 install -r requirements.txt # 安装环境
```
- 在 SolidGPT/solidgpt/src/configuration/Configuration.yaml 中输入 api 密钥

- 输入您的 openai api 令牌

- （可选）输入您的 notion 令牌和页面 id
- 将项目根文件夹设置为 python 路径
- Linux/Mac
```sh
export PYTHONPATH=$PYTHONPATH:$(git rev-parse --show-toplevel)/
```
- Windows

用项目根目录的路径替换 path\to\directory
```cmd
set PYTHONPATH=path\to\directory
```

## 🔥 **运行**

**生成技术解决方案** - 深度结合您的代码提供技术解决方案

```sh
cd quickstart
python3 start_solution.py -r "你的需求" -c "/你的代码文件路径"
```

**生成产品需求文档** - 深度结合您的项目背景提供产品需求文档

```sh
cd quickstart
python3 start_prd.py -r "你的需求" -a <你的项目背景>(可选) -b </你的项目wiki文件路径>(可选)
```

***默认最终输出路径为quickstart文件夹***

### 示例
***生成技术解决方案示例***
```sh
python3 start_solution.py -r "帮我整合捐款 api 与 paypal api" -c /你的相关代码文件路径
```
***生成 PRD 示例***
```sh
# 没有私人数据写 PRD
python3 start_prd.py -r "帮我写一个博客平台 prd"
# 将私人数据纳入考虑
python3 start_prd.py -r "在我的博客中添加捐赠功能" -b /my/project/wiki/file/path.md
python3 start_prd.py -r "在我的博客中添加捐赠功能" -a "我很高兴为您介绍我们的专门的美股博客平台。此平台不仅允许用户注册和提交有见地的文章，还允许读者评论、分享他们的交易观点并了解最新的财经新闻。它经过深思熟虑的设计，旨在培育金融爱好者之间的强烈的思想和信息交流。"
python3 start_prd.py -r "在我的博客中添加捐赠功能" -b /my/project/wiki/file/path.md -a "我很高兴为您介绍我们的专门的美股博客平台。此平台不仅允许用户注册和提交有见地的文章，还允许读者评论、分享他们的交易观点并了解最新的财经新闻。它经过深思熟虑的设计，旨在培育金融爱好者之间的强烈的思想和信息交流。"
```
## 🖇️ 文档
[探索 SolidGPT](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/READMEv1.md)

[Solid Portal](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/solidportal.md)

[Solid GPT 基础设施](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/infrastructure.md)

[深度自定义代理技能](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/customagentskill.md)

[与私人数据的嵌入](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/embeddingprivatedata.md)

[GPT3.5的微调](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/gptfinetuning.md)

[Llama2的微调](https://github.com/AI-Citizen/SolidGPT/blob/main/docs/llama2finetuning.md)

## 联系方式
如果您对我们的项目有任何问题或反馈，请随时与我们联系。我们非常欣赏您的建议！
- 邮箱: aict@ai-citi.com
- GitHub 问题: 对于更技术性的询问，您也可以在我们的[GitHub 仓库](https://github.com/AI-Citizen/SolidGPT/issues)中创建一个新问题。
我们会在2-3个工作日内回复所有问题。
Loading

0 comments on commit 5e0d19f

Please sign in to comment.